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

Примечание

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

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

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

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

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

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

Обзор

Модуль позволяет регистрировать, обновлять и удалять обязательные действия.
Модуль также удаляет все повторяющиеся обязательные действия по их псевдониму. Сохраняется первое вхождение.

Параметры

Параметр	Комментарии
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	Имя realm Keycloak для аутентификации при доступе к API.
auth_username псевдонимы: username string	Имя пользователя для аутентификации при доступе к API.
connection_timeout integer добавлено в community.general 4.5.0	Задает время ожидания HTTP-соединения с API Keycloak (в секундах). По умолчанию: `10`
http_agent string добавлено в community.general 5.4.0	Настраивает HTTP-заголовок User-Agent. По умолчанию: `"Ansible"`
realm string / обязательно	Имя realm, в котором находятся обязательные действия аутентификации.
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
required_actions list / элементы=dictionary	Обязательное действие аутентификации.
alias string / обязательно	Уникальное имя обязательного действия.
config dictionary	Конфигурация обязательного действия.
defaultAction boolean	Указывает, назначается ли обязательное действие новым пользователям. Варианты: `false` `true`
enabled boolean	Указывает, включено ли обязательное действие. Варианты: `false` `true`
name string	Отображаемое имя обязательного действия. Обязательно для регистрации.
priority integer	Приоритет обязательного действия.
providerId string	Идентификатор поставщика обязательного действия. Обязательно для регистрации.
state string / обязательно	Определяет, будут ли обязательные действия аутентификации realm зарегистрированы/обновлены (`present`) или удалены (`absent`). Варианты: `"absent"` `"present"`
token string добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs boolean	Проверять сертификаты 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: Register a new required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "http://localhost:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_actions:
      - alias: "TERMS_AND_CONDITIONS"
        name: "Terms and conditions"
        providerId: "TERMS_AND_CONDITIONS"
        enabled: true
    state: "present"

- name: Update the newly registered required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "http://localhost:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_actions:
      - alias: "TERMS_AND_CONDITIONS"
        enabled: false
    state: "present"

- name: Delete the updated registered required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "http://localhost:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_actions:
      - alias: "TERMS_AND_CONDITIONS"
    state: "absent"

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

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

Ключ	Описание
end_state dictionary	Представление обязательных действий аутентификации после выполнения модуля. Возвращается: при успехе
alias string	Уникальное имя обязательного действия. Возвращается: при успехе Пример: `"test-provider-id"`
config dictionary	Конфигурация обязательного действия. Возвращается: при успехе Пример: `{}`
defaultAction boolean	Указывает, назначается ли обязательное действие новым пользователям. Возвращается: при успехе Пример: `false`
enabled boolean	Указывает, включено ли обязательное действие. Возвращается: при успехе Пример: `false`
name string	Отображаемое имя обязательного действия. Обязательно для регистрации. Возвращается: при успехе Пример: `"Test provider ID"`
priority integer	Приоритет обязательного действия. Возвращается: при успехе Пример: `90`
providerId string	Идентификатор поставщика обязательного действия. Обязательно для регистрации. Возвращается: при успехе Пример: `"test-provider-id"`
msg string	Сообщение о выполненном действии. Возвращается: всегда

Авторы

Skrekulko (@Skrekulko)

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

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