Модуль community.general.keycloak_clientscope_type – Установка типа clientscope в области или клиенте через Keycloak API

Примечание

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

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

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

Для использования в playbook, укажите: community.general.keycloak_clientscope_type.

Новое в community.general 6.6.0

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

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

Этот модуль позволяет устанавливать тип (необязательный, по умолчанию) clientscopes через REST API Keycloak. Требуется доступ к REST API через OpenID Connect; подключающийся пользователь и используемый клиент должны иметь необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь с правами администратора, а также отдельное определение клиента с областью, соответствующей вашим потребностям, и пользователь, имеющий необходимые роли.

Параметры

Параметр	Комментарии
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.
client_id псевдонимы: clientId строка	`client_id` клиента. Если не задано, типы clientscope устанавливаются по умолчанию для области.
connection_timeout целое число добавлено в community.general 4.5.0	Управляет периодом времени ожидания (в секундах) HTTP-соединений с API Keycloak. По умолчанию: `10`
default_clientscopes список / элементы=строка	Клиентские области, которые должны иметь тип по умолчанию.
http_agent строка добавлено в community.general 5.4.0	Настраивает HTTP заголовок User-Agent. По умолчанию: `"Ansible"`
optional_clientscopes список / элементы=строка	Клиентские области, которые должны иметь тип необязательный.
realm строка	Область Keycloak. По умолчанию: `"master"`
token строка добавлено в community.general 3.0.0	Токен аутентификации для Keycloak API.
validate_certs логическое	Проверять сертификаты TLS (не отключайте это в рабочей среде). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

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

Примеры

- name: Set default client scopes on realm level
  community.general.keycloak_clientscope_type:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: "MyCustomRealm"
    default_clientscopes: ['profile', 'roles']
  delegate_to: localhost


- name: Set default and optional client scopes on client level with token auth
  community.general.keycloak_clientscope_type:
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    realm: "MyCustomRealm"
    client_id: "MyCustomClient"
    default_clientscopes: ['profile', 'roles']
    optional_clientscopes: ['phone']
  delegate_to: localhost

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

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

Ключ	Описание
end_state словарь	Представление областей доступа клиента после выполнения модуля. Пример усечён. Возвращается: при успехе Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}`
existing словарь	Представление областей доступа клиента до выполнения модуля. Возвращается: всегда Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": ["phone"]}`
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда Пример: `""`
proposed словарь	Представление предлагаемого отображения типов областей доступа клиента. Возвращается: всегда Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}`

Авторы

Simon Pahl (@simonpahl)

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

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