community / community.general / 1.3.14 / module / keycloak_group Allows administration of Keycloak groups via Keycloak API Authors: Adam Goossens (@adamgoossens)community.general.keycloak_group (1.3.14) — module
Install with ansible-galaxy collection install community.general:==1.3.14
collections: - name: community.general version: 1.3.14
This module allows you to add, remove or modify Keycloak groups 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(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 group, where possible provide the group ID to the module. This removes a lookup to the API to translate the name into the group ID.
- name: Create a Keycloak group community.general.keycloak_group: name: my-new-kc-group 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: Delete a keycloak group community.general.keycloak_group: id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' state: absent realm: MyCustomRealm 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 group based on name community.general.keycloak_group: name: my-group-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: Update the name of a Keycloak group community.general.keycloak_group: id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd' name: an-updated-kc-group-name 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 group with some custom attributes community.general.keycloak_group: 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_group attributes: attrib1: value1 attrib2: value2 attrib3: - with - numerous - individual - list - items delegate_to: localhost
id: description: - The unique identifier for this group. - This parameter is not required for updating or deleting a group but providing it will reduce the number of API calls required. type: str name: description: - Name of the group. - This parameter is required only when creating or updating the group. type: str realm: default: master description: - They Keycloak realm under which this group resides. type: str state: choices: - present - absent default: present description: - State of the group. - On C(present), the group will be created if it does not yet exist, or updated with the parameters you provide. - On C(absent), the group will be removed if it exists. type: str attributes: description: - A dict of key/value pairs to set as custom attributes for the group. - Values may be single values (e.g. a string) or a list of strings. type: dict auth_realm: description: - Keycloak realm name to authenticate to for API access. required: true type: str auth_password: aliases: - password description: - Password to authenticate for API access with. required: true type: str auth_username: aliases: - username description: - Username to authenticate for API access with. required: true 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 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
group: contains: access: description: A dict describing the accesses you have to this group based on the credentials used. returned: always sample: manage: true manageMembership: true view: true type: dict attributes: description: Attributes applied to this group returned: always sample: attr1: - val1 - val2 - val3 type: dict clientRoles: description: A list of client-level roles granted to this group returned: always sample: [] type: list id: description: GUID that identifies the group returned: always sample: 23f38145-3195-462c-97e7-97041ccea73e type: str name: description: Name of the group returned: always sample: grp-test-123 type: str path: description: URI path to the group returned: always sample: /grp-test-123 type: str realmRoles: description: An array of the realm-level roles granted to this group returned: always sample: [] type: list subGroups: description: A list of groups that are children of this group. These groups will have the same parameters as documented here. returned: always type: list description: Group representation of the group after module execution (sample is truncated). returned: always type: complex