Модуль community.general.keycloak_clientsecret_info – Получение секрета клиента через API Keycloak

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install community.general.

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

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

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

Обзор

Этот модуль позволяет получить секрет клиента Keycloak через REST API Keycloak. Он требует доступа к REST API через OpenID Connect; пользователь, подключающийся и клиент, используемый, должны иметь соответствующие права доступа. В стандартной установке Keycloak admin-cli и администраторский пользователь подойдут, как и отдельное определение клиента со scope, настроенным под ваши потребности, и пользователя с соответствующими ролями.
При получении нового секрета клиента, где это возможно, предоставьте id клиента (а не client_id) модулю. Это исключает поиск в API для перевода client_id в идентификатор клиента.
Обратите внимание, что этот модуль возвращает секрет клиента. Чтобы предотвратить его отображение в логах, добавьте no_log: true к задаче.

Параметры

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

Атрибуты

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

Примеры

- name: Get a Keycloak client secret, authentication with credentials
  community.general.keycloak_clientsecret_info:
    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
  delegate_to: localhost
  no_log: true

- name: Get a new Keycloak client secret, authentication with token
  community.general.keycloak_clientsecret_info:
    id: '9d59aa76-2755-48c6-b1af-beb70a82c3cd'
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
  delegate_to: localhost
  no_log: true

- name: Get a new Keycloak client secret, passing client_id instead of id
  community.general.keycloak_clientsecret_info:
    client_id: 'myClientId'
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
  delegate_to: localhost
  no_log: true

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

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

Ключ	Описание
clientsecret_info complex	Представление секрета клиента Возвращаемое значение: при успехе
type string	Тип учетных данных. Возвращаемое значение: всегда Пример: `"secret"`
value string	Секрет клиента. Возвращаемое значение: всегда Пример: `"cUGnX1EIeTtPPAkcyGMv0ncyqDPu68P1"`
msg string	Текстовое описание успеха или неудачи Возвращаемое значение: всегда

Авторы

Fynn Chen (@fynncfchen)
John Cant (@johncant)

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

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