mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-06-05 15:59:09 -07:00
[PR #9529/27c34b15 backport][stable-10] jk*: style adjustments (#9540)
jk*: style adjustments (#9529)
* jk*: style adjustments
* Apply suggestions from code review
* fix return yamls
(cherry picked from commit 27c34b150f
)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
parent
ec58aadaa7
commit
80f43bbbf5
31 changed files with 487 additions and 400 deletions
|
@ -17,12 +17,14 @@ short_description: Retrieve client secret using Keycloak API
|
|||
version_added: 6.1.0
|
||||
|
||||
description:
|
||||
- This module allows you to get a Keycloak client secret using the Keycloak REST API. It requires access to the REST API using 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.
|
||||
- When retrieving a new client secret, where possible provide the client's O(id) (not O(client_id)) to the module. This removes a lookup to
|
||||
the API to translate the O(client_id) into the client ID.
|
||||
- 'Note that this module returns the client secret. To avoid this showing up in the logs, please add C(no_log: true) to the task.'
|
||||
- This module allows you to get a Keycloak client secret using the Keycloak REST API. It requires access to the REST API
|
||||
using 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.
|
||||
- When retrieving a new client secret, where possible provide the client's O(id) (not O(client_id)) to the module. This
|
||||
removes a lookup to the API to translate the O(client_id) into the client ID.
|
||||
- 'Note that this module returns the client secret. To avoid this showing up in the logs, please add C(no_log: true) to
|
||||
the task.'
|
||||
attributes:
|
||||
action_group:
|
||||
version_added: 10.2.0
|
||||
|
@ -37,7 +39,8 @@ options:
|
|||
id:
|
||||
description:
|
||||
- The unique identifier for this client.
|
||||
- This parameter is not required for getting or generating a client secret but providing it will reduce the number of API calls required.
|
||||
- This parameter is not required for getting or generating a client secret but providing it will reduce the number of
|
||||
API calls required.
|
||||
type: str
|
||||
|
||||
client_id:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue