community / community.general / 8.5.0 / module / keycloak_component_info Retrive component info in Keycloak | "added in version" 8.2.0 of community.general" Authors: Andre Desrosiers (@desand01)community.general.keycloak_component_info (8.5.0) — module
Install with ansible-galaxy collection install community.general:==8.5.0
collections: - name: community.general version: 8.5.0
This module retrive information on component from Keycloak.
- name: Retrive info of a UserStorageProvider named myldap community.general.keycloak_component_info: auth_keycloak_url: http://localhost:8080/auth auth_sername: admin auth_password: password auth_realm: master realm: myrealm name: myldap provider_type: org.keycloak.storage.UserStorageProvider
- name: Retrive key info component community.general.keycloak_component_info: auth_keycloak_url: http://localhost:8080/auth auth_sername: 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 community.general.keycloak_component_info: auth_keycloak_url: http://localhost:8080/auth auth_sername: admin auth_password: password auth_realm: master realm: myrealm
- name: Retrive all sub components of parent component filter by type community.general.keycloak_component_info: auth_keycloak_url: http://localhost:8080/auth auth_sername: admin auth_password: password auth_realm: master realm: myrealm parent_id: "075ef2fa-19fc-4a6d-bf4c-249f57365fd2" provider_type: "org.keycloak.storage.ldap.mappers.LDAPStorageMapper"
name: description: - Name of the Component. type: str realm: description: - The name of the realm. required: true type: str token: description: - Authentication token for Keycloak API. type: str version_added: 3.0.0 version_added_collection: community.general parent_id: description: - Container ID of the components. type: str auth_realm: description: - Keycloak realm name to authenticate to for API access. type: str http_agent: default: Ansible description: - Configures the HTTP User-Agent header. type: str version_added: 5.4.0 version_added_collection: community.general auth_password: aliases: - password description: - Password to authenticate for API access with. type: str auth_username: aliases: - username description: - Username to authenticate for API access with. type: str provider_type: description: - Provider type of components. - 'Example: V(org.keycloak.storage.UserStorageProvider), V(org.keycloak.services.clientregistration.policy.ClientRegistrationPolicy), V(org.keycloak.keys.KeyProvider), V(org.keycloak.userprofile.UserProfileProvider), V(org.keycloak.storage.ldap.mappers.LDAPStorageMapper).' type: str auth_client_id: default: admin-cli description: - OpenID Connect C(client_id) to authenticate to the API with. type: str validate_certs: default: true description: - Verify TLS certificates (do not disable this in production). type: bool auth_keycloak_url: aliases: - url description: - URL to the Keycloak instance. required: true type: str auth_client_secret: description: - Client Secret to use in conjunction with O(auth_client_id) (if required). type: str connection_timeout: default: 10 description: - Controls the HTTP connections timeout period (in seconds) to Keycloak API. type: int version_added: 4.5.0 version_added_collection: community.general
components: description: JSON representation of components. elements: dict returned: always type: list