Docs4dev
Docs
ansible / latest / collections / community / general / keycloak_client_rolemapping_module.html

community.general.keycloak_client_rolemapping – Allows administration of Keycloak client_rolemapping with the Keycloak API

Note

This plugin is part of the community.general collection (version 3.8.1).

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 version 3.5.0: of community.general

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 Choices/Defaults Comments
auth_client_id
string
Default:
"admin-cli"
OpenID Connect client_id to authenticate to the API with.
auth_client_secret
string
Client Secret to use in conjunction with auth_client_id (if required).
auth_keycloak_url
string / required
URL to the Keycloak instance.

aliases: url
auth_password
string
Password to authenticate for API access with.

aliases: password
auth_realm
string
Keycloak realm name to authenticate to for API access.
auth_username
string
Username to authenticate for API access with.

aliases: username
cid
string
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.
client_id
string
Name of the client to be mapped (different than cid).
This parameter is required (can be replaced by cid for less API call).
gid
string
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.
group_name
string
Name of the group to be mapped.
This parameter is required (can be replaced by gid for less API call).
realm
string
Default:
"master"
They Keycloak realm under which this role_representation resides.
roles
list / elements=dictionary
Roles to be mapped to the group.
id
string
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
string
Name of the role_representation.
This parameter is required only when creating or updating the role_representation.
state
string
    Choices:
  • present ←
  • absent
State of the client_rolemapping.
On present, the client_rolemapping will be created if it does not yet exist, or updated with the parameters you provide.
On absent, the client_rolemapping will be removed if it exists.
token
string
added in 3.0.0 of community.general
Authentication token for Keycloak API.
validate_certs
boolean
    Choices:
  • no
  • yes ←
Verify TLS certificates (do not disable this in production).

Examples

- name: Map a client role to a group, authentication with credentials
  community.general.keycloak_client_rolemappings:
    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_rolemappings:
    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: Unmap client role from a group
  community.general.keycloak_client_rolemappings:
    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 Returned Description
end_state
dictionary
always
role_representation representation of role_representation after module execution.
The sample is truncated.

Sample:
{'adminUrl': 'http://www.example.com/admin_url', 'attributes': {'request.object.signature.alg': 'RS256'}}
existing
dictionary
always
role_representation representation of existing role_representation.
The sample is truncated.

Sample:
{'adminUrl': 'http://www.example.com/admin_url', 'attributes': {'request.object.signature.alg': 'RS256'}}
msg
string
always
Message as to what action was taken

Sample:
Role role1 assigned to group group1.
proposed
dictionary
always
role_representation representation of proposed changes to client_rolemapping.

Sample:
{'clientId': 'test'}


Authors

  • Gaëtan Daubresse (@Gaetan2907)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/keycloak_client_rolemapping_module.html