community.general.keycloak_role – Allows administration of Keycloak roles via Keycloak API

Note

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

To install it use: ansible-galaxy collection install community.general.

To use it in a playbook, specify: community.general.keycloak_role.

New in version 3.4.0: of community.general

Synopsis

  • This module allows you to add, remove or modify Keycloak roles 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 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.

Parameters

Parameter Choices/Defaults Comments
attributes
dictionary
A dict of key/value pairs to set as custom attributes for the role.
Values may be single values (e.g. a string) or a list of strings.
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
client_id
string
If the role is a client role, the client id under which it resides.
If this parameter is absent, the role is considered a realm role.
description
string
The role description.
name
string / required
Name of the role.
This parameter is required.
realm
string
Default:
"master"
The Keycloak realm under which this role resides.
state
string
    Choices:
  • present ←
  • absent
State of the role.
On present, the role will be created if it does not yet exist, or updated with the parameters you provide.
On absent, the role 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: Create a Keycloak realm role, authentication with credentials
  community.general.keycloak_role:
    name: my-new-kc-role
    realm: MyCustomRealm
    state: present
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
  delegate_to: localhost

- name: Create a Keycloak realm role, authentication with token
  community.general.keycloak_role:
    name: my-new-kc-role
    realm: MyCustomRealm
    state: present
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
  delegate_to: localhost

- name: Create a Keycloak client role
  community.general.keycloak_role:
    name: my-new-kc-role
    realm: MyCustomRealm
    client_id: MyClient
    state: present
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
  delegate_to: localhost

- name: Delete a Keycloak role
  community.general.keycloak_role:
    name: my-role-for-deletion
    state: absent
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
  delegate_to: localhost

- name: Create a keycloak role with some custom attributes
  community.general.keycloak_role:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    name: my-new-role
    attributes:
        attrib1: value1
        attrib2: value2
        attrib3:
            - with
            - numerous
            - individual
            - list
            - items
  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 of role after module execution (sample is truncated)

Sample:
{'attributes': {}, 'clientRole': True, 'composite': False, 'containerId': '9f03eb61-a826-4771-a9fd-930e06d2d36a', 'description': 'My updated client test role', 'id': '561703dd-0f38-45ff-9a5a-0c978f794547', 'name': 'myrole'}
existing
dictionary
always
Role representation of existing role

Sample:
{'attributes': {}, 'clientRole': True, 'composite': False, 'containerId': '9f03eb61-a826-4771-a9fd-930e06d2d36a', 'description': 'My client test role', 'id': '561703dd-0f38-45ff-9a5a-0c978f794547', 'name': 'myrole'}
msg
string
always
Message as to what action was taken

Sample:
Role myrole has been updated
proposed
dictionary
always
Role representation of proposed changes to role

Sample:
{'description': 'My updated test description'}


Authors

  • Laurent Paumier (@laurpaum)