Модуль community.general.keycloak_client_rolescope – Позволяет управлять областью действия ролей клиентов Keycloak, чтобы ограничить использование определенных ролей другими конкретными клиентскими приложениями.

Примечание

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

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

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

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

Новое в community.general 8.6.0

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

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

Этот модуль позволяет добавлять или удалять роли Keycloak из области действия клиентов через REST API Keycloak. Для этого требуется доступ к REST API через OpenID Connect; пользователь, подключающийся и используемый клиент, должны иметь необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь с правами администратора, а также отдельное определение клиента с областью действия, соответствующей вашим потребностям, и пользователь, имеющий ожидаемые роли.
Клиент client_id должен иметь full_scope_allowed установленным в false.
Атрибуты являются многозначными в API Keycloak. Все атрибуты представляют собой списки отдельных значений, и этот модуль будет возвращать их именно так. Вы можете передавать отдельные значения для атрибутов при вызове модуля, и это будет преобразовано в список, подходящий для API.

Параметры

Параметр	Комментарии
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 / обязательно	Роли, предоставленные в `role_names`, будут добавлены в эту область действия клиента.
client_scope_id string	Если `role_names` являются ролью клиента, то ID клиента, в котором она находится. Если этот параметр отсутствует, роли считаются ролями области.
connection_timeout integer добавлено в community.general 4.5.0	Управляет периодом времени ожидания (в секундах) HTTP-соединений к API Keycloak. По умолчанию: `10`
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
realm string	Область Keycloak, в которой находятся клиенты. По умолчанию: `"master"`
role_names list / элементы=string / обязательно	Имена ролей для обработки. Если `client_scope_id` присутствует, все роли должны находиться под этим клиентом. Если `client_scope_id` отсутствует, все роли должны находиться под областью.
state string	Состояние сопоставления ролей. При `present`, все роли в `role_names` будут сопоставлены, если они еще не существуют. При `absent`, все сопоставления ролей в `role_names` будут удалены, если они существуют. Варианты: `"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`), когда используется режим сравнения.

Примеры

- name: Add roles to public client scope
  community.general.keycloak_client_rolescope:
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: MyCustomRealm
    client_id: frontend-client-public
    client_scope_id: backend-client-private
    role_names:
    - backend-role-admin
    - backend-role-user

- name: Remove roles from public client scope
  community.general.keycloak_client_rolescope:
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: MyCustomRealm
    client_id: frontend-client-public
    client_scope_id: backend-client-private
    role_names:
    - backend-role-admin
    state: absent

- name: Add realm roles to public client scope
  community.general.keycloak_client_rolescope:
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: MyCustomRealm
    client_id: frontend-client-public
    role_names:
    - realm-role-admin
    - realm-role-user

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

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

Ключ	Описание
end_state список / элементы=словарь	Представление роли роли scope после выполнения модуля. Возвращается: при успехе Пример: `[{"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "47293104-59a6-46f0-b460-2e9e3c9c424c", "name": "backend-role-admin"}, {"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "39c62a6d-542c-4715-92d2-41021eb33967", "name": "backend-role-user"}]`
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда Пример: `"Client role scope for frontend-client-public has been updated"`

Ключ

Описание

end_state

список / элементы=словарь

Представление роли роли scope после выполнения модуля.

Возвращается: при успехе

Пример: [{"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "47293104-59a6-46f0-b460-2e9e3c9c424c", "name": "backend-role-admin"}, {"clientRole": false, "composite": false, "containerId": "MyCustomRealm", "id": "39c62a6d-542c-4715-92d2-41021eb33967", "name": "backend-role-user"}]

msg

строка

Сообщение о том, какое действие было выполнено.

Возвращается: всегда

Пример: "Client role scope for frontend-client-public has been updated"

Авторы

Andre Desrosiers (@desand01)

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

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