ansible / ansible.builtin / v2.9.27 / module / keycloak_clienttemplate Allows administration of Keycloak client templates via Keycloak API | "added in version" 2.5 of ansible.builtin" Authors: Eike Frost (@eikef) preview | supported by communityansible.builtin.keycloak_clienttemplate (v2.9.27) — module
pip
Install with pip install ansible==2.9.27
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(http://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.
- name: Create or update Keycloak client template (minimal) local_action: module: keycloak_clienttemplate auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com/auth auth_realm: master auth_username: USERNAME auth_password: PASSWORD realm: master name: this_is_a_test
- name: delete Keycloak client template local_action: module: keycloak_clienttemplate auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com/auth auth_realm: master auth_username: USERNAME auth_password: PASSWORD realm: master state: absent name: test01
- name: Create or update Keycloak client template (with a protocol mapper) local_action: module: keycloak_clienttemplate auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com/auth auth_realm: master auth_username: USERNAME auth_password: PASSWORD realm: master name: this_is_a_test protocol_mappers: - config: access.token.claim: True claim.name: "family_name" id.token.claim: True jsonType.label: String user.attribute: lastName userinfo.token.claim: True consentRequired: True consentText: "${familyName}" name: family name protocol: openid-connect protocolMapper: oidc-usermodel-property-mapper full_scope_allowed: false id: bce6f5e9-d7d3-4955-817e-c5b7f8d65b3f
id: description: - Id of client template to be worked on. This is usually a UUID. name: description: - Name of the client template realm: description: - Realm this client template is found in. state: choices: - present - absent default: present description: - 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 token: description: - Authentication token for Keycloak API. type: str version_added: 3.0.0 version_added_collection: community.general protocol: choices: - openid-connect - saml description: - Type of client template (either C(openid-connect) or C(saml). attributes: description: - 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. auth_realm: description: - Keycloak realm name to authenticate to for API access. type: str description: description: - Description of the client template in Keycloak auth_password: aliases: - password description: - Password to authenticate for API access with. type: str auth_username: aliases: - username description: - Username to authenticate for API access with. type: str auth_client_id: default: admin-cli description: - OpenID Connect I(client_id) to authenticate to the API with. type: str validate_certs: default: true description: - Verify TLS certificates (do not disable this in production). type: bool protocol_mappers: description: - a list of dicts defining protocol mappers for this client template. This is 'protocolMappers' in the Keycloak REST API. suboptions: config: description: - Dict specifying the configuration options for the protocol mapper; the contents differ depending on the value of I(protocolMapper) and are not documented other than by the source of the mappers and its parent class(es). An example is given below. It is easiest to obtain valid config values by dumping an already-existing protocol mapper configuration through check-mode in the "existing" field. consentRequired: description: - Specifies whether a user needs to provide consent to a client for this mapper to be active. consentText: description: - The human-readable name of the consent the user is presented to accept. id: description: - Usually a UUID specifying the internal ID of this protocol mapper instance. name: description: - The name of this protocol mapper. protocol: choices: - openid-connect - saml description: - is either 'openid-connect' or 'saml', this specifies for which protocol this protocol mapper is active. protocolMapper: description: - The Keycloak-internal name of the type of this protocol-mapper. While an exhaustive list is impossible to provide since this may be extended through SPIs by the user of Keycloak, by default Keycloak as of 3.4 ships with at least - C(docker-v2-allow-all-mapper) - C(oidc-address-mapper) - C(oidc-full-name-mapper) - C(oidc-group-membership-mapper) - C(oidc-hardcoded-claim-mapper) - C(oidc-hardcoded-role-mapper) - C(oidc-role-name-mapper) - C(oidc-script-based-protocol-mapper) - C(oidc-sha256-pairwise-sub-mapper) - C(oidc-usermodel-attribute-mapper) - C(oidc-usermodel-client-role-mapper) - C(oidc-usermodel-property-mapper) - C(oidc-usermodel-realm-role-mapper) - C(oidc-usersessionmodel-note-mapper) - C(saml-group-membership-mapper) - C(saml-hardcode-attribute-mapper) - C(saml-hardcode-role-mapper) - C(saml-role-list-mapper) - C(saml-role-name-mapper) - C(saml-user-attribute-mapper) - C(saml-user-property-mapper) - C(saml-user-session-note-mapper) - An exhaustive list of available mappers on your installation can be obtained on the admin console by going to Server Info -> Providers and looking under 'protocol-mapper'. auth_keycloak_url: aliases: - url description: - URL to the Keycloak instance. required: true type: str auth_client_secret: description: - Client Secret to use in conjunction with I(auth_client_id) (if required). type: str connection_timeout: default: 10 description: - Controls the HTTP connections timeout period (in seconds) to Keycloak API. type: int version_added: 4.5.0 version_added_collection: community.general full_scope_allowed: description: - Is the "Full Scope Allowed" feature set for this client template or not. This is 'fullScopeAllowed' in the Keycloak REST API. type: bool
end_state: description: client template representation of client template after module execution (sample is truncated) returned: always sample: description: test01 fullScopeAllowed: false id: 9c3712ab-decd-481e-954f-76da7b006e5f name: test01 protocol: saml type: dict existing: description: client template representation of existing client template (sample is truncated) returned: always sample: description: test01 fullScopeAllowed: false id: 9c3712ab-decd-481e-954f-76da7b006e5f name: test01 protocol: saml type: dict msg: description: Message as to what action was taken returned: always sample: Client template testclient has been updated type: str proposed: description: client template representation of proposed changes to client template returned: always sample: name: test01 type: dict