# keycloak_component_info – Retrieve component info in Keycloak — Keycloak Ansible Collection documentation

# keycloak_component_info – Retrieve component 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_component_info`.

New in middleware_automation.keycloak 3.0.0

## Synopsis

- This module retrieve information on component from Keycloak.

## 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`
http_agent string | Configures the HTTP User-Agent header. Default: `"Ansible"`
name string | Name of the Component.
parent_id string | Container ID of the components.
provider_type string | Provider type of components. Examples: `org.keycloak.storage.UserStorageProvider`, `org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy`, `org.keycloak.keys.KeyProvider`, `org.keycloak.userprofile.UserProfileProvider`, `org.keycloak.storage.ldap.mappers.LDAPStorageMapper`.
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.0.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: Retrive info of a UserStorageProvider named myldap
      middleware_automation.keycloak.keycloak_component_info:
        auth_keycloak_url: http://localhost:8080
        auth_username: admin
        auth_password: password
        auth_realm: master
        realm: myrealm
        name: myldap
        provider_type: org.keycloak.storage.UserStorageProvider

    - name: Retrive key info component
      middleware_automation.keycloak.keycloak_component_info:
        auth_keycloak_url: http://localhost:8080
        auth_username: admin
        auth_password: password
        auth_realm: master
        realm: myrealm
        name: rsa-enc-generated
        provider_type: org.keycloak.keys.KeyProvider

    - name: Retrive all component from realm master
      middleware_automation.keycloak.keycloak_component_info:
        auth_keycloak_url: http://localhost:8080
        auth_username: admin
        auth_password: password
        auth_realm: master
        realm: myrealm

    - name: Retrive all sub components of parent component filter by type
      middleware_automation.keycloak.keycloak_component_info:
        auth_keycloak_url: http://localhost:8080
        auth_username: admin
        auth_password: password
        auth_realm: master
        realm: myrealm
        parent_id: "075ef2fa-19fc-4a6d-bf4c-249f57365fd2"
        provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"

## Return Values

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

Key | Description
--- | ---
components list / elements=dictionary | JSON representation of components. Returned: always

### Authors

- Andre Desrosiers (@desand01)