keycloak_organization_info – Retrieve organization info in Keycloak

Note

This module is part of the middleware_automation.keycloak collection.

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 middleware_automation.keycloak.

To use it in a playbook, specify: middleware_automation.keycloak.keycloak_organization_info.

New in middleware_automation.keycloak 3.1.0

Synopsis

• This module retrieves information on organizations from Keycloak.

• Organizations are available in Keycloak 26 and later. The realm must have organizations enabled before this module can be used.

Parameters

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.
connection_timeout integer	Controls the HTTP connections timeout period (in seconds) to Keycloak API. Default: 10
exact boolean	Whether the search should be an exact match. Only relevant when name is provided. Choices: false true ← (default)
http_agent string	Configures the HTTP User-Agent header. Default: "Ansible"
name string	Name of the organization to search for. If not provided, all organizations in the realm are returned.
realm string / required	The name of the realm.
refresh_token string	Authentication refresh token for Keycloak API.
token string	Authentication token for Keycloak API.
validate_certs boolean	Verify TLS certificates (do not disable this in production). Choices: false true ← (default)

Attributes

Attribute	Support	Description
action_group	Action group: middleware_automation.keycloak.keycloak added in middleware_automation.keycloak 3.1.0	Use group/middleware_automation.keycloak.keycloak in module_defaults to set defaults for this module.
check_mode	Support: full This action does not modify state.	Can run in check_mode and return changed status prediction without modifying target.
diff_mode	Support: N/A This action does not modify state.	Will return details on what has changed (or possibly needs changing in check_mode), when in diff mode.

Examples

- name: Retrieve a specific organization by name
  middleware_automation.keycloak.keycloak_organization_info:
    auth_keycloak_url: https://auth.example.com
    auth_username: admin
    auth_password: password
    auth_realm: master
    realm: MyRealm
    name: my-org

- name: List all organizations in a realm
  middleware_automation.keycloak.keycloak_organization_info:
    auth_keycloak_url: https://auth.example.com
    auth_username: admin
    auth_password: password
    auth_realm: master
    realm: MyRealm

- name: Search organizations by partial name
  middleware_automation.keycloak.keycloak_organization_info:
    auth_keycloak_url: https://auth.example.com
    auth_username: admin
    auth_password: password
    auth_realm: master
    realm: MyRealm
    name: acme
    exact: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
organizations list / elements=dictionary	JSON representation of organizations. Returned: always

Authors

• Chris Brown (@chribro)