Модуль community.general.keycloak_authz_authorization_scope – Позволяет администрировать области авторизации клиентов Keycloak через API Keycloak

Примечание

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

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

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

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

Новое в community.general 6.6.0

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

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

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

Атрибуты

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

Примеры

- 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 сложный	Представление области авторизации после выполнения модуля. Возвращается: при успехе
display_name строка	Имя отображения области авторизации. Возвращается: когда `state=present` Пример: `"File delete"`
icon_uri строка	URI иконки для области авторизации. Возвращается: когда `state=present` Пример: `"http://localhost/icon.png"`
id строка	ID области авторизации. Возвращается: когда `state=present` Пример: `"a6ab1cf2-1001-40ec-9f39-48f23b6a0a41"`
name строка	Имя области авторизации. Возвращается: когда `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_authorization_scope_module.html