community.general.keycloak_realm_info module – Allows obtaining Keycloak realm public information via Keycloak API
Note
This module is part of the community.general collection (version 9.5.1).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.keycloak_realm_info
.
New in community.general 4.3.0
Synopsis
This module allows you to get Keycloak realm public information via the Keycloak REST API.
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 |
Comments |
---|---|
URL to the Keycloak instance. |
|
They Keycloak realm ID. Default: |
|
Verify TLS certificates (do not disable this in production). Choices:
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- name: Get a Keycloak public key
community.general.keycloak_realm_info:
realm: MyCustomRealm
auth_keycloak_url: https://auth.example.com/auth
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Message as to what action was taken. Returned: always |
|
Representation of the realm public information. Returned: always |
|
Account console URL. Returned: always Sample: |
|
Public key of the realm. Returned: always Sample: |
|
Realm ID. Returned: always Sample: |
|
Token endpoint URL. Returned: always Sample: |
|
The token not before. Returned: always Sample: |