Модуль community.general.keycloak_component — позволяет администрировать компоненты Keycloak с помощью API Keycloak

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: community.general.keycloak_component.

Новое в community.general 10.0.0

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

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

Этот модуль позволяет администрировать компоненты Keycloak с помощью REST API Keycloak. Для этого требуется доступ к REST API через OpenID Connect; у подключающегося пользователя и используемого realm должны быть необходимые права доступа. В стандартной установке Keycloak подойдут admin-cli и пользователь admin, а также отдельное определение realm с областью действия, настроенной в соответствии с вашими потребностями, и пользователь с необходимыми ролями.
Названия параметров модуля представляют собой варианты в snake_case названий в camelCase, используемых в API Keycloak и его документации: https://www.keycloak.org/docs-api/latest/rest-api/index.html. Предусмотрены псевдонимы, поэтому можно также использовать варианты в camelCase.

Параметры

Параметр	Комментарии
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	Имя realm Keycloak для аутентификации при доступе к API.
auth_username псевдонимы: username string	Имя пользователя для аутентификации при доступе к API.
config dictionary	Параметры конфигурации провайдера. Содержимое зависит от типа провайдера.
connection_timeout integer добавлено в community.general 4.5.0	Задаёт время ожидания HTTP-подключения к API Keycloak (в секундах). По умолчанию: `10`
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
name string / обязательный	Имя создаваемого компонента.
parent_id string / обязательный	Идентификатор parent_id компонента. На практике это идентификатор (имя) realm.
provider_id string / обязательный	Имя «идентификатора провайдера» для ключа.
provider_type string / обязательный	Имя «типа провайдера» для ключа. Например, `org.keycloak.storage.UserStorageProvider`, `org.keycloak.userprofile.UserProfileProvider`, … См. https://www.keycloak.org/docs/latest/server_development/index.html#_providers.
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
state string	Состояние компонента Keycloak. При `present` компонент создаётся (или обновляется, если он уже существует). При `absent` компонент удаляется, если он существует. Варианты: `"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	Поддержка: полная	В режиме diff возвращает сведения об изменениях (или возможных изменениях в `check_mode`).

Примеры

- name: Manage Keycloak User Storage Provider
  community.general.keycloak_component:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master
    name: my storage provider
    state: present
    parent_id: some_realm
    provider_id: my storage
    provider_type: "org.keycloak.storage.UserStorageProvider"
    config:
      myCustomKey: "my_custom_key"
      cachePolicy: "NO_CACHE"
      enabled: true

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

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

Ключ	Описание
end_state dictionary	Представление keycloak_component после выполнения модуля. Возвращается: при успешном выполнении
config dictionary	Конфигурация компонента. Возвращается: при успешном выполнении
id string	Идентификатор компонента. Возвращается: при `state=present` Пример: `"5b7ec13f-99da-46ad-8326-ab4c73cf4ce4"`
name string	Имя компонента. Возвращается: при `state=present` Пример: `"mykey"`
parentId string	Идентификатор realm, которому принадлежит этот ключ. Возвращается: при `state=present` Пример: `"myrealm"`
providerId string	Идентификатор провайдера ключа. Возвращается: при `state=present` Пример: `"rsa"`
providerType string	Тип провайдера. Возвращается: при `state=present`

Авторы

Björn Bösel (@fivetide)

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

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