community.general.keycloak_authentication модуль — Настройка аутентификации в Keycloak

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: community.general.keycloak_authentication.

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

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

Описание

Этот модуль фактически только может скопировать существующий поток аутентификации, добавить в него выполнение и настроить его.
Он также может удалить поток.

Параметры

Параметр	Комментарии
alias строка / обязательно	Псевдоним для потока аутентификации.
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.
authenticationExecutions список / элементы=словарь	Структура конфигурации для выполнений.
authenticationConfig словарь	Описание конфигурации аутентификации.
displayName строка	Имя выполнения или подпотока для создания или обновления.
flowAlias строка	Псевдоним родительского потока.
index целое число	Порядок приоритета выполнения.
providerId строка	`providerID` для нового потока, если он не копируется из существующего потока.
requirement строка	Управление состоянием подпотока или выполнения. Варианты: `"REQUIRED"` `"ALTERNATIVE"` `"DISABLED"` `"CONDITIONAL"`
subFlowType строка добавлено в community.general 6.6.0	Для новых подпотоков, необязательно укажите тип. Используется только при создании. Варианты: `"basic-flow"` ← (по умолчанию) `"form-flow"`
connection_timeout целое число добавлено в community.general 4.5.0	Управляет временем ожидания HTTP-соединений (в секундах) с API Keycloak. По умолчанию: `10`
copyFrom строка	`flowAlias` потока аутентификации для использования при копировании.
description строка	Описание потока.
force логическое значение	Если `true`, позволяет удалить поток аутентификации и пересоздать его. Варианты: `false` ← (по умолчанию) `true`
http_agent строка добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
providerId строка	`providerId` для нового потока, если он не копируется из существующего потока. Варианты: `"basic-flow"` `"client-flow"`

END_OF_DOCUMENT_MARKER

realm строка / обязательно	Имя домена, в котором выполняется аутентификация.
state строка	Управление тем, должен ли существовать поток аутентификации. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка добавлен в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs булево	Проверять сертификаты TLS (не отключайте это в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Create an authentication flow from first broker login and add an execution to it.
  community.general.keycloak_authentication:
    auth_keycloak_url: http://localhost:8080/auth
    auth_realm: master
    auth_username: admin
    auth_password: password
    realm: master
    alias: "Copy of first broker login"
    copyFrom: "first broker login"
    authenticationExecutions:
      - providerId: "test-execution1"
        requirement: "REQUIRED"
        authenticationConfig:
            alias: "test.execution1.property"
            config:
            test1.property: "value"
      - providerId: "test-execution2"
        requirement: "REQUIRED"
        authenticationConfig:
            alias: "test.execution2.property"
            config:
            test2.property: "value"
    state: present

- name: Re-create the authentication flow
  community.general.keycloak_authentication:
    auth_keycloak_url: http://localhost:8080/auth
    auth_realm: master
    auth_username: admin
    auth_password: password
    realm: master
    alias: "Copy of first broker login"
    copyFrom: "first broker login"
    authenticationExecutions:
      - providerId: "test-provisioning"
        requirement: "REQUIRED"
        authenticationConfig:
            alias: "test.provisioning.property"
            config:
            test.provisioning.property: "value"
    state: present
    force: true

- name: Create an authentication flow with subflow containing an execution.
  community.general.keycloak_authentication:
    auth_keycloak_url: http://localhost:8080/auth
    auth_realm: master
    auth_username: admin
    auth_password: password
    realm: master
    alias: "Copy of first broker login"
    copyFrom: "first broker login"
    authenticationExecutions:
      - providerId: "test-execution1"
        requirement: "REQUIRED"
      - displayName: "New Subflow"
        requirement: "REQUIRED"
      - providerId: "auth-cookie"
        requirement: "REQUIRED"
        flowAlias: "New Sublow"
    state: present

- name: Remove authentication.
  community.general.keycloak_authentication:
    auth_keycloak_url: http://localhost:8080/auth
    auth_realm: master
    auth_username: admin
    auth_password: password
    realm: master
    alias: "Copy of first broker login"
    state: absent

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

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

Ключ	Описание
end_state словарь	Представление аутентификации после выполнения модуля. Возвращается: при успехе Пример: {"alias": "Copy of first broker login", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда

Ключ

Описание

end_state

словарь

Представление аутентификации после выполнения модуля.

Возвращается: при успехе

Пример: {"alias": "Copy of first broker login", "authenticationExecutions": [{"alias": "review profile config", "authenticationConfig": {"alias": "review profile config", "config": {"update.profile.on.first.login": "missing"}, "id": "6f09e4fb-aad4-496a-b873-7fa9779df6d7"}, "configurable": true, "displayName": "Review Profile", "id": "8f77dab8-2008-416f-989e-88b09ccf0b4c", "index": 0, "level": 0, "providerId": "idp-review-profile", "requirement": "REQUIRED", "requirementChoices": ["REQUIRED", "ALTERNATIVE", "DISABLED"]}], "builtIn": false, "description": "Actions taken after first broker login with identity provider account, which is not yet linked to any Keycloak account", "id": "bc228863-5887-4297-b898-4d988f8eaa5c", "providerId": "basic-flow", "topLevel": true}

msg

строка

Сообщение о том, какое действие было выполнено.

Возвращается: всегда

Авторы

Philippe Gauthier (@elfelip)
Gaëtan Daubresse (@Gaetan2907)

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

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