Модуль community.general.keycloak_authz_permission_info — Запрос информации об авторизации клиентов Keycloak

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install community.general.

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

Новая в community.general 7.2.0

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

Описание

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

Параметры

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

Атрибуты

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

Примеры

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

Авторы

Samuli Seppänen (@mattock)

Ссылки на сборку

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