Модуль community.general.keycloak_user_execute_actions_email — отправка пользователю письма для выполнения действий Keycloak

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: community.general.keycloak_user_execute_actions_email.

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

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

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

Вызывает конечную точку Keycloak execute-actions-email для пользователя. При этом отправляется письмо с одним или несколькими обязательными действиями, которые должен выполнить пользователь (например, сбросить пароль).
Если список actions не указан, используется действие по умолчанию UPDATE_PASSWORD.
Необходимо указать либо id, либо username пользователя. Если указать только username, будет выполнен дополнительный запрос для поиска.
Этот модуль всегда сообщает changed=true, поскольку отправка письма является побочным эффектом и не может быть идемпотентной.

Параметры

Параметр	Комментарии
actions list / elements=string	Список обязательных действий, которые нужно включить в письмо. По умолчанию: `["UPDATE_PASSWORD"]`
auth_client_id string	`client_id` OpenID Connect для аутентификации в API. По умолчанию: `"admin-cli"`
auth_client_secret string	Секрет клиента, используемый вместе с `auth_client_id` (если требуется).
auth_keycloak_url псевдонимы: url string / обязательный	URL экземпляра Keycloak.
auth_password псевдонимы: password string	Пароль для аутентификации при доступе к API.
auth_realm string	Имя области Keycloak для аутентификации при доступе к API.
auth_username string	Имя пользователя для аутентификации при доступе к API.
client_id псевдонимы: clientId string	Необязательный идентификатор клиента, используемый для ссылки перенаправления.
connection_timeout integer добавлено в community.general 4.5.0	Задает время ожидания HTTP-соединения с API Keycloak (в секундах). По умолчанию: `10`
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
id string	Уникальный идентификатор пользователя (UUID). Не может использоваться одновременно с `username`.
lifespan integer	Необязательный срок действия токена действия (в секундах; поддерживается в новых версиях Keycloak). Если задан, передается как параметр запроса.
realm string	Область Keycloak, в которой находится пользователь. По умолчанию: `"master"`
redirect_uri псевдонимы: redirectUri string	Необязательный URI перенаправления. Если задан `client_id`, URI должен быть допустимым для указанного клиента.
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
token string добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
username string	Имя пользователя. Не может использоваться одновременно с `id`.
validate_certs boolean	Проверять сертификаты TLS (не отключайте эту проверку в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
action_group	Группа действий: community.general.keycloak	Используйте `group/community.general.keycloak` в `module_defaults`, чтобы задать значения по умолчанию для этого модуля.
check_mode	Поддержка: full	Модуль можно запустить в `check_mode`; он вернет прогноз статуса изменений, не изменяя целевой объект.
diff_mode	Поддержка: none	В режиме сравнения возвращает сведения о том, что изменилось (или, возможно, должно измениться в `check_mode`).

Примеры

- name: Password reset email (default action) with 1h lifespan
  community.general.keycloak_user_execute_actions_email:
    username: johndoe
    realm: MyRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: ADMIN
    auth_password: SECRET
    lifespan: 3600
  delegate_to: localhost

- name: Multiple required actions using token auth
  community.general.keycloak_user_execute_actions_email:
    username: johndoe
    actions:
      - UPDATE_PASSWORD
      - VERIFY_EMAIL
    realm: MyRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
  delegate_to: localhost

- name: Email by user id with redirect
  community.general.keycloak_user_execute_actions_email:
    id: 9d59aa76-2755-48c6-b1af-beb70a82c3cd
    client_id: my-frontend
    redirect_uri: https://app.example.com/post-actions
    actions:
      - UPDATE_PASSWORD
    realm: MyRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: ADMIN
    auth_password: SECRET
  delegate_to: localhost

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

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

Ключ	Описание
actions list / elements=string	Список действий, включенных в письмо. Возвращается: при успешном выполнении
user_id string	Идентификатор пользователя, которому было (или было бы в режиме проверки) отправлено письмо. Возвращается: при успешном выполнении

Авторы

Marius Bertram (@mariusbertram)

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

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