модуль community.general.keycloak_authz_custom_policy — позволяет администрировать пользовательские политики JavaScript клиента 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_custom_policy.

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

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

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

Этот модуль позволяет администрировать пользовательские политики JavaScript клиента Keycloak с помощью REST API Keycloak. Пользовательские политики JavaScript доступны только в том случае, если для клиента включена авторизация и они развернуты на сервере Keycloak в виде JAR-файлов.
Для работы модулю необходим доступ к REST API через OpenID Connect; подключающийся пользователь и используемый realm должны иметь необходимые права доступа. При стандартной установке Keycloak подойдут admin-cli и пользователь-администратор, а также отдельное описание realm с областью действия, настроенной в соответствии с вашими потребностями, и пользователь с необходимыми ролями.
Названия параметров модуля представляют собой версии в snake_case параметров Keycloak в camelCase. Пути и данные запросов 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 строка	Имя realm Keycloak для аутентификации при доступе к API.
auth_username псевдонимы: username строка	Имя пользователя для аутентификации при доступе к API.
client_id строка / обязательный	`clientId` клиента 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 строка / обязательный	Имя создаваемой пользовательской политики.
policy_type строка / обязательный	Тип политики. Он должен совпадать с именем пользовательской политики, развернутой на сервере. Можно создать несколько политик одного типа, но их имена должны различаться.
realm строка / обязательный	Имя realm Keycloak, в котором находится клиент Keycloak.
refresh_token строка добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
state строка	Состояние пользовательской политики. При `present` пользовательская политика создается (или обновляется, если уже существует). При `absent` пользовательская политика удаляется, если она существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs логическое значение	Проверять сертификаты 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 custom authorization policy
  community.general.keycloak_authz_custom_policy:
    name: OnlyOwner
    state: present
    policy_type: script-policy.js
    client_id: myclient
    realm: myrealm
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master

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

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

Ключ	Описание
end_state словарь	Представление пользовательской политики после выполнения модуля. Возвращается: при успехе
name строка	Имя пользовательской политики. Возвращается: при state=present Пример: `"file:delete"`
policy_type строка	Тип пользовательской политики. Возвращается: при state=present Пример: `"File delete"`
msg строка	Сообщение о выполненном действии. Возвращается: всегда

Авторы

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