community.general.keycloak_authz_custom_policy модуль – Позволяет администрирование пользовательских политик Javascript клиента Keycloak через API Keycloak

Примечание

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

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

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

Для использования в playbook, укажите: community.general.keycloak_authz_custom_policy.

Новое в community.general 7.5.0

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

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

Этот модуль позволяет администрирование пользовательских Javascript клиента Keycloak через REST API Keycloak. Пользовательские политики Javascript доступны только в том случае, если для клиента включена авторизация и если они были развернуты на сервере Keycloak в виде JAR-файлов.
Этот модуль требует доступа к REST API через OpenID Connect; пользователь, подключающийся и используемая область, должны иметь необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь с правами администратора, а также отдельное определение области с областью действия, соответствующей вашим потребностям, и пользователь, имеющий необходимые роли.
Имена параметров модуля — это snake_case версии camelCase параметров, используемых Keycloak. Пути и полезные нагрузки служб авторизации официально не документированы проектом 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 строка / обязательно	`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 строка / обязательно	Имя области Keycloak, в которой находится клиент Keycloak.
state строка	Состояние пользовательской политики. При значении `present`, пользовательская политика будет создана (или обновлена, если она уже существует). При значении `absent`, пользовательская политика будет удалена, если она существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
token строка добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs булево	Проверять сертификаты TLS (не отключайте это в production). Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в `check_mode` и возвращать прогноз изменения статуса без модификации целевого объекта.
diff_mode	Поддержка: отсутствует	Вернет подробности о том, что изменилось (или, возможно, нуждается в изменении в `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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/keycloak_authz_custom_policy_module.html