`__. - Attributes are multi\-valued in the Keycloak API. All attributes are lists of individual values and are returned that way by this module. You may pass single values for attributes when calling the module, and this is translated into a list suitable for the API. - When updating a user\_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. .. Aliases .. Requirements .. Options Parameters ---------- .. raw:: html

Parameter	Comments
auth_client_id string	OpenID Connect client_id to authenticate to the API with. Default: `"admin-cli"`
auth_client_secret string	Client Secret to use in conjunction with auth_client_id (if required).
auth_keycloak_url aliases: url string / required	URL to the Keycloak instance.
auth_password aliases: password string	Password to authenticate for API access with.
auth_realm string	Keycloak realm name to authenticate to for API access.
auth_username aliases: username string	Username to authenticate for API access with.
cid string	ID of the client whose role is to be mapped. This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required. If neither `cid` nor `client_id` is specified, a realm role is mapped instead.
client_id string	Name of the client (different than `cid`) whose role is to be mapped. This parameter is required if `cid` is not provided (can be replaced by `cid` to reduce the number of API calls that must be made). If neither `cid` nor `client_id` is specified, a realm role is mapped instead.
connection_timeout integer	Controls the HTTP connections timeout period (in seconds) to Keycloak API. Default: `10`
http_agent string	Configures the HTTP User-Agent header. Default: `"Ansible"`
realm string	They Keycloak realm under which this role_representation resides. Default: `"master"`
refresh_token string	Authentication refresh token for Keycloak API.
roles list / elements=dictionary	Roles to be mapped to the user.
id string	The unique identifier for this role_representation. This parameter is not required for updating or deleting a role_representation but providing it reduces 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.
service_account_user_client_id string	Client ID of the service-account-user to be mapped. This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.
state string	State of the user_rolemapping. On `present`, the user_rolemapping is created if it does not yet exist, or updated with the parameters you provide. On `absent`, the user_rolemapping is removed if it exists. Choices: `"present"` ← (default) `"absent"`
target_username string	Username of the user roles are mapped to. This parameter is not required (can be replaced by uid for less API call).
token string	Authentication token for Keycloak API.
uid string	ID of the user to be mapped. This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API calls required.
validate_certs boolean	Verify TLS certificates (do not disable this in production). Choices: `false` `true` ← (default)

.. Attributes Attributes ---------- .. tabularcolumns:: \X{2}{10}\X{3}{10}\X{5}{10} .. list-table:: :width: 100% :widths: auto :header-rows: 1 :class: longtable ansible-option-table * - Attribute - Support - Description * - .. raw:: html

.. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-action_group: .. rst-class:: ansible-option-title **action_group** .. raw:: html .. raw:: html

- .. raw:: html

:ansible-attribute-support-property:`Action group:` |antsibull-internal-nbsp|:ansible-attribute-support-full:`middleware\_automation.keycloak.keycloak` :ansible-option-versionadded:`added in middleware\_automation.keycloak 3.0.0` .. raw:: html

- .. raw:: html

Use :literal:`group/middleware\_automation.keycloak.keycloak` in :literal:`module\_defaults` to set defaults for this module. .. raw:: html

* - .. raw:: html

.. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-check_mode: .. rst-class:: ansible-option-title **check_mode** .. raw:: html .. raw:: html

- .. raw:: html

:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html

- .. raw:: html

Can run in :literal:`check\_mode` and return changed status prediction without modifying target. .. raw:: html

* - .. raw:: html

.. _ansible_collections.middleware_automation.keycloak.keycloak_user_rolemapping_module__attribute-diff_mode: .. rst-class:: ansible-option-title **diff_mode** .. raw:: html .. raw:: html

- .. raw:: html

:ansible-attribute-support-label:`Support: \ `\ :ansible-attribute-support-full:`full` .. raw:: html

- .. raw:: html

Will return details on what has changed (or possibly needs changing in :literal:`check\_mode`\ ), when in diff mode. .. raw:: html

.. Notes .. Seealso .. Examples Examples -------- .. code-block:: yaml+jinja - name: Map a realm role to a user, authentication with credentials middleware_automation.keycloak.keycloak_user_rolemapping: realm: MyCustomRealm auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com auth_realm: master auth_username: USERNAME auth_password: PASSWORD state: present uid: user_uid roles: - name: role_name1 id: role_id1 - name: role_name2 id: role_id2 delegate_to: localhost - name: Map a client role to a user, authentication with credentials middleware_automation.keycloak.keycloak_user_rolemapping: realm: MyCustomRealm auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com auth_realm: master auth_username: USERNAME auth_password: PASSWORD state: present client_id: client1 uid: user_uid roles: - name: role_name1 id: role_id1 - name: role_name2 id: role_id2 delegate_to: localhost - name: Map a client role to a service account user for a client, authentication with credentials middleware_automation.keycloak.keycloak_user_rolemapping: realm: MyCustomRealm auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com auth_realm: master auth_username: USERNAME auth_password: PASSWORD state: present client_id: client1 service_account_user_client_id: clientIdOfServiceAccount roles: - name: role_name1 id: role_id1 - name: role_name2 id: role_id2 delegate_to: localhost - name: Map a client role to a user, authentication with token middleware_automation.keycloak.keycloak_user_rolemapping: realm: MyCustomRealm auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com token: TOKEN state: present client_id: client1 target_username: user1 roles: - name: role_name1 id: role_id1 - name: role_name2 id: role_id2 delegate_to: localhost - name: Unmap client role from a user middleware_automation.keycloak.keycloak_user_rolemapping: realm: MyCustomRealm auth_client_id: admin-cli auth_keycloak_url: https://auth.example.com auth_realm: master auth_username: USERNAME auth_password: PASSWORD state: absent client_id: client1 uid: 70e3ae72-96b6-11e6-9056-9737fd4d0764 roles: - name: role_name1 id: role_id1 - name: role_name2 id: role_id2 delegate_to: localhost .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Description
end_state dictionary	Representation of client role mapping after module execution. The sample is truncated. Returned: on success Sample: `{"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}`
existing dictionary	Representation of existing client role mapping. The sample is truncated. Returned: always Sample: `{"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}`
msg string	Message as to what action was taken. Returned: always Sample: `"Role role1 assigned to user user1."`
proposed dictionary	Representation of proposed client role mapping. Returned: always Sample: `{"clientId": "test"}`

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Dušan Marković (@bratwurzt) - Ivan Kokalović (@koke1997) .. Extra links .. Parsing errors