Модуль community.general.keycloak_authz_permission_info — получение сведений о разрешениях авторизации клиента Keycloak

Примечание

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

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

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

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

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

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

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

Этот модуль позволяет получать с помощью REST API Keycloak сведения о разрешениях авторизации клиента Keycloak из конечной точки ресурсов. Разрешения авторизации доступны, только если для клиента включена авторизация.
Для работы модуля необходим доступ к REST API через OpenID Connect; подключающийся пользователь и используемый realm должны иметь необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь с правами администратора, а также отдельное определение realm с областью действия, настроенной в соответствии с вашими потребностями, и пользователь с необходимыми ролями.
Названия параметров модуля представляют собой варианты в snake_case параметров в camelCase, используемых Keycloak. Пути и полезные данные 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`
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
name string / обязательный	Имя создаваемого разрешения авторизации.
realm string / обязательный	Имя realm Keycloak, в котором находится клиент Keycloak.
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	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой объект.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме сравнения возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примеры

- name: Query Keycloak authorization permission
  community.general.keycloak_authz_permission_info:
    name: ScopePermission
    client_id: myclient
    realm: myrealm
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master

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

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

Ключ	Описание
msg string	Сообщение о выполненном действии. Возвращается: всегда
queried_state dictionary	Состояние ресурса (политики) согласно данным Keycloak. Возвращается: при успехе
config dictionary	Конфигурация разрешения (во всех наблюдавшихся случаях пустая). Возвращается: при успехе Пример: `{}`
decisionStrategy string	Стратегия принятия решения. Возвращается: при успехе Пример: `"UNANIMOUS"`
description string	Описание разрешения авторизации. Возвращается: при успехе Пример: `"Resource Permission"`
id string	Идентификатор разрешения авторизации. Возвращается: при успехе Пример: `"9da05cd2-b273-4354-bbd8-0c133918a454"`
logic string	Логика, используемая для разрешения (входит в полезные данные, но имеет фиксированное значение). Возвращается: при успехе Пример: `"POSITIVE"`
name string	Имя разрешения авторизации. Возвращается: при успехе Пример: `"ResourcePermission"`
type string	Тип разрешения авторизации. Возвращается: при успехе Пример: `"resource"`

Авторы

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_permission_info_module.html