модуль community.general.keycloak_realm_keys_metadata_info — позволяет получать метаданные ключей realm Keycloak с помощью API Keycloak

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать её в плейбуке, укажите: community.general.keycloak_realm_keys_metadata_info.

Добавлено в community.general 9.3.0

Краткое описание
Параметры
Атрибуты
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет получать метаданные ключей realm Keycloak с помощью REST API Keycloak.
Названия параметров модуля представляют собой версии в snake_case названий camelCase из API Keycloak и его документации по адресу https://www.keycloak.org/docs-api/latest/rest-api/index.html.

Параметры

Параметр	Комментарии
auth_client_id string	Клиент OpenID Connect `client_id` для аутентификации в API. По умолчанию: `"admin-cli"`
auth_client_secret string	Секрет клиента, используемый вместе с `auth_client_id` (если требуется).
auth_keycloak_url псевдонимы: url string / обязательный	URL экземпляра Keycloak.
auth_password псевдонимы: password string	Пароль для аутентификации при доступе к API.
auth_realm string	Имя realm Keycloak для аутентификации при доступе к API.
auth_username псевдонимы: username string	Имя пользователя для аутентификации при доступе к API.
connection_timeout integer добавлено в community.general 4.5.0	Задает время ожидания HTTP-подключения к API Keycloak (в секундах). По умолчанию: `10`
http_agent string добавлено в community.general 5.4.0	Настраивает HTTP-заголовок User-Agent. По умолчанию: `"Ansible"`
realm string	Realm Keycloak, для которого требуется получить метаданные ключей. По умолчанию: `"master"`
refresh_token string добавлено в community.general 10.3.0	Токен обновления для аутентификации в API Keycloak.
token string добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs boolean	Проверять сертификаты TLS (не отключайте эту проверку в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.keycloak добавлено в community.general 10.2.0	Используйте `group/community.general.keycloak` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз изменения статуса, не изменяя целевой объект.
diff_mode	Поддержка: не применимо Это действие не изменяет состояние.	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Fetch Keys metadata
  community.general.keycloak_realm_keys_metadata_info:
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: MyCustomRealm
  delegate_to: localhost
  register: keycloak_keys_metadata

- name: Write the Keycloak keys certificate into a file
  ansible.builtin.copy:
    dest: /tmp/keycloak.cert
    content: |
      {{ keys_metadata['keycloak_keys_metadata']['keys']
      | selectattr('algorithm', 'equalto', 'RS256')
      | map(attribute='certificate')
      | first
      }}
  delegate_to: localhost

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
keys_metadata dictionary	Представление метаданных ключей realm (см. https://www.keycloak.org/docs-api/latest/rest-api/index.html#KeysMetadataRepresentation). Возвращается: всегда
active dictionary	Сопоставление (то есть словарь) алгоритмов ключей с UUID. Возвращается: всегда
keys list / элементы=dictionary	Список словарей с подробными сведениями о ключах. Возвращается: всегда
msg string	Сообщение о выполненном действии. Возвращается: всегда

Авторы

Thomas Bach (@thomasbach-dev)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/keycloak_realm_keys_metadata_info_module.html