community.general.keycloak_client_rolemapping module – Allows administration of Keycloak client_rolemapping with the Keycloak API
Note
This module is part of the community.general collection (version 9.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.keycloak_client_rolemapping
.
New in community.general 3.5.0
Synopsis
This module allows you to add, remove or modify Keycloak client_rolemapping with 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 https://www.keycloak.org/docs-api/8.0/rest-api/index.html.
Attributes are multi-valued in the Keycloak API. All attributes are lists of individual values and will be returned that way by this module. You may pass single values for attributes when calling the module, and this will be translated into a list suitable for the API.
When updating a client_rolemapping, where possible provide the role ID to the module. This removes a lookup to the API to translate the name into the role ID.
Parameters
Parameter |
Comments |
---|---|
OpenID Connect Default: |
|
Client Secret to use in conjunction with |
|
URL to the Keycloak instance. |
|
Password to authenticate for API access with. |
|
Keycloak realm name to authenticate to for API access. |
|
Username to authenticate for API access with. |
|
Id of the client to be mapped. This parameter is not required for updating or deleting the rolemapping but providing it will reduce the number of API calls required. |
|
Name of the client to be mapped (different than This parameter is required (can be replaced by cid for less API call). |
|
Controls the HTTP connections timeout period (in seconds) to Keycloak API. Default: |
|
Id of the group to be mapped. This parameter is not required for updating or deleting the rolemapping but providing it will reduce the number of API calls required. |
|
Name of the group to be mapped. This parameter is required (can be replaced by gid for less API call). |
|
Configures the HTTP User-Agent header. Default: |
|
List of parent groups for the group to handle sorted top to bottom. Set this if your group is a subgroup and you do not provide the GID in |
|
Identify parent by ID. Needs less API calls than using A deep parent chain can be started at any point when first given parent is given as ID. Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred. |
|
Identify parent by name. Needs more internal API calls than using When giving a parent chain with only names it must be complete up to the top. Note that in principle both ID and name can be specified at the same time but current implementation only always use just one of them, with ID being preferred. |
|
They Keycloak realm under which this role_representation resides. Default: |
|
Roles to be mapped to the group. |
|
The unique identifier for this role_representation. This parameter is not required for updating or deleting a role_representation but providing it will reduce the number of API calls required. |
|
Name of the role_representation. This parameter is required only when creating or updating the role_representation. |
|
State of the client_rolemapping. On On Choices:
|
|
Authentication token for Keycloak API. |
|
Verify TLS certificates (do not disable this in production). Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: full |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Map a client role to a group, authentication with credentials
community.general.keycloak_client_rolemapping:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com/auth
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
state: present
client_id: client1
group_name: group1
roles:
- name: role_name1
id: role_id1
- name: role_name2
id: role_id2
delegate_to: localhost
- name: Map a client role to a group, authentication with token
community.general.keycloak_client_rolemapping:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com/auth
token: TOKEN
state: present
client_id: client1
group_name: group1
roles:
- name: role_name1
id: role_id1
- name: role_name2
id: role_id2
delegate_to: localhost
- name: Map a client role to a subgroup, authentication with token
community.general.keycloak_client_rolemapping:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com/auth
token: TOKEN
state: present
client_id: client1
group_name: subgroup1
parents:
- name: parent-group
roles:
- name: role_name1
id: role_id1
- name: role_name2
id: role_id2
delegate_to: localhost
- name: Unmap client role from a group
community.general.keycloak_client_rolemapping:
realm: MyCustomRealm
auth_client_id: admin-cli
auth_keycloak_url: https://auth.example.com/auth
auth_realm: master
auth_username: USERNAME
auth_password: PASSWORD
state: absent
client_id: client1
group_name: group1
roles:
- name: role_name1
id: role_id1
- name: role_name2
id: role_id2
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Representation of client role mapping after module execution. The sample is truncated. Returned: on success Sample: |
|
Representation of existing client role mapping. The sample is truncated. Returned: always Sample: |
|
Message as to what action was taken. Returned: always Sample: |
|
Representation of proposed client role mapping. Returned: always Sample: |