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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка	Используемый для аутентификации в API OpenID Connect. По умолчанию: `"admin-cli"`
auth_client_secret строка	Секретный ключ клиента для использования совместно с `auth_client_id` (при необходимости).
auth_keycloak_url псевдонимы: url строка / обязательно	URL-адрес экземпляра Keycloak.
auth_password псевдонимы: пароль строка	Пароль для аутентификации с API.
auth_realm строка	Имя домена Keycloak для аутентификации с API.
auth_username псевдонимы: имя пользователя строка	Имя пользователя для аутентификации с API.
connection_timeout целое число добавлено в community.general 4.5.0	Управляет временем ожидания HTTP-соединений (в секундах) с API Keycloak. По умолчанию: `10`
http_agent строка добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
realm строка / обязательно	Имя домена, в котором находятся необходимые действия аутентификации.
required_actions список / элементы=словарь	Требуемое действие аутентификации.
alias строка / обязательно	Уникальное имя требуемого действия.
config словарь	Настройка требуемого действия.
defaultAction логическое	Указывает, будет ли требуемое действие назначено всем новым пользователям. Варианты: `false` `true`
enabled логическое	Указывает, включено ли требуемое действие. Варианты: `false` `true`
name строка	Отображаемое имя требуемого действия. Требуется для регистрации.
priority целое число	Приоритет требуемого действия.
providerId строка	Идентификатор поставщика требуемого действия. Требуется для регистрации.
state строка / обязательно	Управление регистрацией/обновлением (`present`) или удалением (`absent`) действий аутентификации домена. Варианты: `"absent"` `"present"`
token строка добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs логическое	Проверять TLS-сертификаты (не отключайте это в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

END_OF_DOCUMENT_MARKER

Атрибуты

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

Примеры

- 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_action:
      - 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_action:
      - 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_action:
      - alias: "TERMS_AND_CONDITIONS"
    state: "absent"

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

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

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

Авторы

Skrekulko (@Skrekulko)

Ссылки на сборку

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