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

Новое в community.general 4.3.0

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

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

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

Параметры

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

Атрибуты

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

Примеры

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

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

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

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

Авторы

Fynn Chen (@fynncfchen)

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

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