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

Примечание

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

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

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

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

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

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

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

Этот модуль позволяет управлять областями авторизации клиентов Keycloak с помощью REST API Keycloak. Области авторизации доступны, только если для клиента включена авторизация.
Для работы этому модулю требуется доступ к REST API через OpenID Connect; пользователь, выполняющий подключение, и используемый realm должны иметь необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь admin, а также отдельное определение realm с областью действия, настроенной согласно вашим потребностям, и пользователь с необходимыми ролями.
Названия параметров модуля представляют собой варианты имен параметров Keycloak в camelCase, записанные в snake_case. Пути и полезные данные Authorization Services официально не документированы проектом Keycloak. https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/.

Параметры

Параметр	Комментарии
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.
client_id string / обязательный	`clientId` клиента Keycloak, для которого нужно задать область авторизации. Обычно это понятное человеку имя клиента Keycloak.
connection_timeout integer добавлено в community.general 4.5.0	Задает время ожидания HTTP-подключения к API Keycloak (в секундах). По умолчанию: `10`
display_name string	Отображаемое имя области авторизации.
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
icon_uri string	URI значка области авторизации.
name string / обязательный	Имя создаваемой области авторизации.
realm string / обязательный	Имя realm Keycloak, в котором находится клиент Keycloak.
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
state string	Состояние области авторизации. При значении `present` область авторизации создается (или обновляется, если она уже существует). При значении `absent` область авторизации удаляется, если она существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
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	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или о том, что, возможно, нужно изменить в `check_mode`).

Примеры

- name: Manage Keycloak file:delete authorization scope
  keycloak_authz_authorization_scope:
    name: file:delete
    state: present
    display_name: File delete
    client_id: myclient
    realm: myrealm
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master

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

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

Ключ	Описание
end_state dictionary	Представление области авторизации после выполнения модуля. Возвращается: при успешном выполнении
display_name string	Отображаемое имя области авторизации. Возвращается: если `state=present` Пример: `"File delete"`
icon_uri string	URI значка области авторизации. Возвращается: если `state=present` Пример: `"http://localhost/icon.png"`
id string	Идентификатор области авторизации. Возвращается: если `state=present` Пример: `"a6ab1cf2-1001-40ec-9f39-48f23b6a0a41"`
name string	Имя области авторизации. Возвращается: если `state=present` Пример: `"file:delete"`
msg string	Сообщение о выполненном действии. Возвращается: всегда

Авторы

Samuli Seppänen (@mattock)

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

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