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

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Keycloak_clienttemplate

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

• #attributes ⇒ Object^?

  A dict of further attributes for this client template.

• #description ⇒ Object^?

  Description of the client template in Keycloak.

• #full_scope_allowed ⇒ Boolean^?

  Is the “Full Scope Allowed” feature set for this client template or not.

• #id ⇒ String^?

  Id of client template to be worked on.

• #name ⇒ String^?

  Name of the client template.

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

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

• #protocol_mappers ⇒ Array<Hash>, ...

  A list of dicts defining protocol mappers for this client template.

• #realm ⇒ String^?

  Realm this client template is found in.

• #state ⇒ :present, ...

  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.

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^?

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

attribute :attributes

#description ⇒ Object^?

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

attribute :description

#full_scope_allowed ⇒ Boolean^?

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

attribute :full_scope_allowed

#id ⇒ String^?

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

attribute :id

#name ⇒ String^?

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

attribute :name

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

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

attribute :protocol

#protocol_mappers ⇒ Array<Hash>, ...

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

attribute :protocol_mappers

#realm ⇒ String^?

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

attribute :realm

#state ⇒ :present, ...

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

attribute :state