Class: Ansible::Ruby::Modules::Keycloak_clienttemplate

Inherits:
Base show all
Defined in:
lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb

Overview

This module allows the administration of Keycloak client templates via the Keycloak REST API. It requires access to the REST API via OpenID Connect; the user connecting and the client being used must have the requisite access rights. In a default Keycloak installation, admin-cli and an admin user would work, as would a separate client definition with the scope tailored to your needs and a user having the expected roles. The names of module options are snake_cased versions of the camelCase ones found in the Keycloak API and its documentation at U(www.keycloak.org/docs-api/3.3/rest-api/) The Keycloak API does not always enforce for only sensible settings to be used – you can set SAML-specific settings on an OpenID Connect client for instance and vice versa. Be careful. If you do not specify a setting, usually a sensible default is chosen.

Instance Method Summary collapse

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#attributes ⇒ Object?

Returns A dict of further attributes for this client template. This can contain various configuration settings, though in the default installation of Keycloak as of 3.4, none are documented or known, so this is usually empty.

Returns:

  • (Object, nil) —

    A dict of further attributes for this client template. This can contain various configuration settings, though in the default installation of Keycloak as of 3.4, none are documented or known, so this is usually empty.



45
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 45

attribute :attributes

#description ⇒ Object?

Returns Description of the client template in Keycloak.

Returns:

  • (Object, nil) —

    Description of the client template in Keycloak



30
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 30

attribute :description

#full_scope_allowed ⇒ Boolean?

Returns Is the “Full Scope Allowed” feature set for this client template or not. This is ‘fullScopeAllowed’ in the Keycloak REST API.

Returns:

  • (Boolean, nil) —

    Is the “Full Scope Allowed” feature set for this client template or not. This is ‘fullScopeAllowed’ in the Keycloak REST API.



37
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 37

attribute :full_scope_allowed

#id ⇒ String?

Returns Id of client template to be worked on. This is usually a UUID.

Returns:

  • (String, nil) —

    Id of client template to be worked on. This is usually a UUID.



18
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 18

attribute :id

#name ⇒ String?

Returns Name of the client template.

Returns:

  • (String, nil) —

    Name of the client template



26
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 26

attribute :name

#protocol ⇒ :"openid-connect", ...

Returns Type of client template (either C(openid-connect) or C(saml).

Returns:

  • (:"openid-connect", :saml, nil) —

    Type of client template (either C(openid-connect) or C(saml).



33
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 33

attribute :protocol

#protocol_mappers ⇒ Array<Hash>, ...

Returns a list of dicts defining protocol mappers for this client template. This is ‘protocolMappers’ in the Keycloak REST API.

Returns:

  • (Array<Hash>, Hash, nil) —

    a list of dicts defining protocol mappers for this client template. This is ‘protocolMappers’ in the Keycloak REST API.



41
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 41

attribute :protocol_mappers

#realm ⇒ String?

Returns Realm this client template is found in.

Returns:

  • (String, nil) —

    Realm this client template is found in.



22
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 22

attribute :realm

#state ⇒ :present, ...

Returns State of the client template,On C(present), the client template will be created (or updated if it exists already).,On C(absent), the client template will be removed if it exists.

Returns:

  • (:present, :absent, nil) —

    State of the client template,On C(present), the client template will be created (or updated if it exists already).,On C(absent), the client template will be removed if it exists



14
 
# File 'lib/ansible/ruby/modules/generated/identity/keycloak/keycloak_clienttemplate.rb', line 14

attribute :state