Модуль community.general.keycloak_realm_keys_metadata_info – Получение метаданных ключей домена Keycloak через API Keycloak

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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

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

Описание

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогноз о статусе изменения без модификации целевого объекта.
diff_mode	Поддержка: нет Это действие не изменяет состояние.	Возвратит подробности о том, что изменилось (или, возможно, что нужно изменить в `check_mode`), при использовании режима diff.

Примеры

- 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 словарь	Представление метаданных ключей домена (см. https://www.keycloak.org/docs-api/latest/rest-api/index.html#KeysMetadataRepresentation). Возвращается: всегда
active словарь	Сопоставление (т. е., словарь) алгоритмов ключей с UUID. Возвращается: всегда
keys список / элементы=словарь	Список словарей, содержащих подробную информацию о ключах. Возвращается: всегда
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда

Авторы

Thomas Bach (@thomasbach-dev)

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

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