Модуль community.general.keycloak_realm_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_info.

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

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

Описание

Этот модуль позволяет получить публичную информацию о домене Keycloak через REST API Keycloak.
Имена параметров модуля — это snake_case версии camelCase параметров из API Keycloak и его документации по адресу https://www.keycloak.org/docs-api/8.0/rest-api/index.html.
Атрибуты в API Keycloak могут быть многозначными. Все атрибуты — списки отдельных значений, и этот модуль вернёт их в таком виде. Вы можете передавать отдельные значения атрибутов при вызове модуля, и это будет преобразовано в список, подходящий для API.

Параметры

Параметр	Комментарии
auth_keycloak_url aliases: url строка / обязательно	URL сервера Keycloak.
realm строка	Идентификатор домена Keycloak. По умолчанию: `"master"`
validate_certs логическое	Проверять сертификаты TLS (не отключайте это в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Get a Keycloak public key
  community.general.keycloak_realm_info:
    realm: MyCustomRealm
    auth_keycloak_url: https://auth.example.com/auth
  delegate_to: localhost

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда
realm_info словарь	Представление общедоступной информации о домене. Возвращается: всегда
account-service строка	URL консоли учетных записей. Возвращается: всегда Пример: `"https://auth.example.com/auth/realms/MyRealm/account"`
public_key строка	Открытый ключ домена. Возвращается: всегда Пример: `"MIIBIjANBgkqhkiG9w0BAQEFAAO..."`
realm строка	Идентификатор домена. Возвращается: всегда Пример: `"MyRealm"`
token-service строка	URL конечной точки токена. Возвращается: всегда Пример: `"https://auth.example.com/auth/realms/MyRealm/protocol/openid-connect"`
tokens-not-before целое число	Время не ранее, чем для токена. Возвращается: всегда Пример: `0`

Авторы

Финн Чен (@fynncfchen)

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

© 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_info_module.html