Модуль community.general.keycloak_clientsecret_regenerate — Перегенерировать секрет клиента Keycloak через API Keycloak

Примечание

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

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

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

Для использования в книге задач укажите: community.general.keycloak_clientsecret_regenerate.

Новая функция в community.general 6.1.0

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

Обзор

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

Параметры

…

Параметр	Комментарии
auth_client_id строка	OpenID Connect `client_id` для аутентификации в 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.
client_id алиасы: clientId строка	client_id клиента. Передача этого значения вместо id приводит к дополнительным обращениям к API.
connection_timeout целое число добавлено в community.general 4.5.0	Управляет временем ожидания HTTP-соединений (в секундах) с API Keycloak. По умолчанию: `10`

Атрибуты

…

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать предсказанный статус изменений без изменения целевого объекта.

Примеры

- name: Regenerate a Keycloak client secret, authentication with credentials
  community.general.keycloak_clientsecret_regenerate:
    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: Regenerate a Keycloak client secret, authentication with token
  community.general.keycloak_clientsecret_regenerate:
    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: Regenerate a 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

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

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

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

Авторы

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_regenerate_module.html