mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-25 13:34:01 -07:00
keycloak_user_rolemapping: docs fixes and examples about mapping realm roles in keycloak_user_rolemapping (#10953)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.17) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.12) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.17+py3.7) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+alpine319+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+fedora39+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.17+ubuntu2004+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run
* Fix docs and add examples about mapping realm roles for keycloak_user_rolemapping.py module (#7149) * fix sanity tests
This commit is contained in:
parent
4c7be8f268
commit
258e65f5fc
1 changed files with 21 additions and 2 deletions
|
|
@ -70,15 +70,17 @@ options:
|
||||||
client_id:
|
client_id:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- Name of the client to be mapped (different than O(cid)).
|
- Name of the client (different than O(cid)) whose role is to be mapped.
|
||||||
- This parameter is required if O(cid) is not provided (can be replaced by O(cid) to reduce the number of API calls
|
- This parameter is required if O(cid) is not provided (can be replaced by O(cid) to reduce the number of API calls
|
||||||
that must be made).
|
that must be made).
|
||||||
|
- If neither O(cid) nor O(client_id) is specified, a B(realm) role is mapped instead.
|
||||||
cid:
|
cid:
|
||||||
type: str
|
type: str
|
||||||
description:
|
description:
|
||||||
- ID of the client to be mapped.
|
- 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
|
- This parameter is not required for updating or deleting the rolemapping but providing it reduces the number of API
|
||||||
calls required.
|
calls required.
|
||||||
|
- If neither O(cid) nor O(client_id) is specified, a B(realm) role is mapped instead.
|
||||||
roles:
|
roles:
|
||||||
description:
|
description:
|
||||||
- Roles to be mapped to the user.
|
- Roles to be mapped to the user.
|
||||||
|
|
@ -106,6 +108,23 @@ author:
|
||||||
"""
|
"""
|
||||||
|
|
||||||
EXAMPLES = r"""
|
EXAMPLES = r"""
|
||||||
|
- name: Map a realm role to a user, authentication with credentials
|
||||||
|
community.general.keycloak_user_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
|
||||||
|
user_id: user1Id
|
||||||
|
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
|
- name: Map a client role to a user, authentication with credentials
|
||||||
community.general.keycloak_user_rolemapping:
|
community.general.keycloak_user_rolemapping:
|
||||||
realm: MyCustomRealm
|
realm: MyCustomRealm
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue