Модуль community.general.keycloak_clientsecret_regenerate — повторная генерация секрета клиента Keycloak с помощью API Keycloak

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 и пользователь с правами администратора, а также отдельное определение клиента с областью действия, настроенной в соответствии с вашими потребностями, и пользователь с необходимыми ролями.
При повторной генерации секрета клиента по возможности передавайте модулю ID клиента (не client_id). Это избавит от обращения к API для преобразования client_id в 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 строка	Имя 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`
http_agent строка добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
id строка	Уникальный идентификатор этого клиента. Этот параметр не требуется для получения или генерации секрета клиента, однако его передача сокращает количество необходимых вызовов API.
realm строка	Realm Keycloak, в котором находится этот клиент. По умолчанию: `"master"`
refresh_token строка добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
token строка добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs логический	Проверять сертификаты TLS (не отключайте эту проверку в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.keycloak добавлено в community.general 10.2.0	Используйте `group/community.general.keycloak` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: полная	Модуль может работать в режиме `check_mode` и возвращать прогноз состояния изменений, не изменяя целевой объект.
diff_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

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

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

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

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

Авторы

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

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

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