Модуль community.general.keycloak_realm_rolemapping — управление сопоставлениями ролей области Keycloak в группах с помощью API Keycloak

Примечание

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

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

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

Чтобы использовать её в сценарии, укажите: community.general.keycloak_realm_rolemapping.

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

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

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

Этот модуль позволяет добавлять, удалять и изменять сопоставления ролей области Keycloak в группах с помощью REST API Keycloak. Для этого необходим доступ к REST API через OpenID Connect; подключающийся пользователь и используемый клиент должны иметь соответствующие права доступа. В конфигурации Keycloak по умолчанию подойдут admin-cli и пользователь с ролью администратора, а также отдельное определение клиента с областью действия, настроенной согласно вашим требованиям, и пользователь с необходимыми ролями.
Имена параметров модуля представляют собой варианты имён из API Keycloak и его документации https://www.keycloak.org/docs-api/18.0/rest-api/index.html в формате snake_case.
В API Keycloak атрибуты могут содержать несколько значений. Все атрибуты являются списками отдельных значений и возвращаются этим модулем в таком виде. При вызове модуля для атрибутов можно передавать одиночные значения — они преобразуются в список, подходящий для API.
При обновлении group_rolemapping по возможности передавайте модулю идентификатор роли. Это позволяет избежать запроса к 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.
connection_timeout integer добавлен в community.general 4.5.0	Задаёт время ожидания HTTP-соединения с API Keycloak (в секундах). По умолчанию: `10`
gid string	Идентификатор сопоставляемой группы. Этот параметр не требуется для обновления или удаления сопоставления ролей, но его указание уменьшает количество необходимых вызовов API.
group_name string	Имя сопоставляемой группы. Этот параметр обязателен (для уменьшения количества вызовов API его можно заменить на gid).
http_agent string добавлен в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
parents list / elements=dictionary	Список родительских групп для обработки группы, отсортированный сверху вниз. Укажите этот параметр, если ваша группа является подгруппой и вы не передаёте GID в `gid`.
id string	Указывает родительскую группу по идентификатору. Требует меньше вызовов API, чем использование `parents[].name`. Цепочку вложенных родительских групп можно начать с любого уровня, если первая указанная родительская группа задана по идентификатору. Обратите внимание: теоретически можно одновременно указать идентификатор и имя, но текущая реализация всегда использует только одно из них, отдавая предпочтение идентификатору.
name string	Указывает родительскую группу по имени. Для преобразования имён в идентификаторы при обработке требуется больше внутренних вызовов API, чем при использовании `parents[].id`. Если цепочка родительских групп задана только именами, её необходимо указать полностью вплоть до верхнего уровня. Обратите внимание: теоретически можно одновременно указать идентификатор и имя, но текущая реализация всегда использует только одно из них, отдавая предпочтение идентификатору.
realm string	Область Keycloak, в которой находится этот role_representation. По умолчанию: `"master"`
refresh_token string добавлен в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
roles list / elements=dictionary	Роли, сопоставляемые группе.
id string	Уникальный идентификатор этого role_representation. Этот параметр не требуется для обновления или удаления role_representation, но его указание уменьшает количество необходимых вызовов API.
name string	Имя role_representation. Этот параметр обязателен только при создании или обновлении role_representation.
state string	Состояние realm_rolemapping. При значении `present` realm_rolemapping создаётся, если он ещё не существует, или обновляется с указанными параметрами. При значении `absent` realm_rolemapping удаляется, если он существует. Допустимые значения: `"present"` ← (по умолчанию) `"absent"`
token string добавлен в community.general 3.0.0	Токен аутентификации для API Keycloak.
validate_certs boolean	Проверять сертификаты 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	Поддержка: полная	В режиме сравнения возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Map a client role to a group, authentication with credentials
  community.general.keycloak_realm_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Map a client role to a group, authentication with token
  community.general.keycloak_realm_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    state: present
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Map a client role to a subgroup, authentication with token
  community.general.keycloak_realm_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    state: present
    group_name: subgroup1
    parents:
      - name: parent-group
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Unmap realm role from a group
  community.general.keycloak_realm_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: absent
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

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

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

Ключ	Описание
end_state dictionary	Представление сопоставления ролей клиента после выполнения модуля. Образец приведён не полностью. Возвращается: при успешном выполнении Образец: `{"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}`
existing dictionary	Представление существующего сопоставления ролей клиента. Образец приведён не полностью. Возвращается: всегда Образец: `{"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}`
msg string	Сообщение о выполненном действии. Возвращается: всегда Образец: `"Role role1 assigned to group group1."`
proposed dictionary	Представление предлагаемого сопоставления ролей клиента. Возвращается: всегда Образец: `{"clientId": "test"}`

Авторы

Gaëtan Daubresse (@Gaetan2907)
Marius Huysamen (@mhuysamen)
Alexander Groß (@agross)

Ссылки на коллекцию

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