Модуль community.general.keycloak_clientscope_type — задание типа области клиента в realm или клиенте с помощью API Keycloak

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: community.general.keycloak_clientscope_type.

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

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

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

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

Параметры

Параметр	Комментарии
auth_client_id string	Идентификатор клиента OpenID Connect `client_id` для аутентификации в 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.
client_id псевдонимы: clientId string	`client_id` клиента. Если параметр не задан, типы областей клиента задаются по умолчанию для realm.
connection_timeout integer добавлено в community.general 4.5.0	Задает период ожидания HTTP-соединения с API Keycloak (в секундах). По умолчанию: `10`
default_clientscopes list / элементы=string	Области клиента, которым следует назначить тип «по умолчанию».
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
optional_clientscopes list / элементы=string	Области клиента, которым следует назначить тип «необязательный».
realm string	Realm Keycloak. По умолчанию: `"master"`
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
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	Поддержка: full	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: full	В режиме 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 dictionary	Представление областей клиента после выполнения модуля. Пример усечен. Возвращается: при успешном выполнении Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}`
existing dictionary	Представление областей клиента до выполнения модуля. Возвращается: всегда Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": ["phone"]}`
msg string	Сообщение о выполненном действии. Возвращается: всегда Пример: `""`
proposed dictionary	Представление предлагаемого сопоставления типов областей клиента. Возвращается: всегда Пример: `{"default_clientscopes": ["profile", "role"], "optional_clientscopes": []}`

Авторы

Simon Pahl (@simonpahl)

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

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