Модуль community.general.keycloak_user — создание и настройка пользователя в Keycloak

Примечание

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

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

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

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

Новая возможность в community.general 7.1.0

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

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

Этот модуль создаёт, удаляет или обновляет пользователей Keycloak.

Параметры

Параметр	Комментарии
access dictionary	Доступ пользователя к списку.
attributes list / elements=dictionary	Список атрибутов пользователя.
name string	Имя атрибута.
state string	Указывает, должен ли атрибут существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
values list / elements=string	Значения атрибута в виде списка.
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 string	Имя пользователя для аутентификации при обращении к API.
client_consents псевдонимы: clientConsents list / elements=dictionary	Тип средства аутентификации клиента. По умолчанию: `[]`
client_id псевдонимы: clientId string / обязательный	ID клиента для роли клиента. Не технический ID клиента.
roles list / elements=string / обязательный	Список ролей клиента, назначаемых пользователю.
connection_timeout integer добавлено в community.general 4.5.0	Задаёт период ожидания HTTP-соединения с API Keycloak (в секундах). По умолчанию: `10`
credentials list / elements=dictionary	Учётные данные пользователя. По умолчанию: `[]`
temporary boolean	Если `true`, пользователям необходимо сбросить свои учётные данные при следующем входе. Варианты: `false` ← (по умолчанию) `true`
type string / обязательный	Тип учётных данных.
value string / обязательный	Значение учётных данных.
disableable_credential_types псевдонимы: disableableCredentialTypes list / elements=string	Список типов учётных данных пользователя. По умолчанию: `[]`
email string	Адрес электронной почты пользователя.
email_verified псевдонимы: emailVerified boolean	Проверка достоверности адреса электронной почты пользователя. Варианты: `false` ← (по умолчанию) `true`
enabled boolean	Активен ли пользователь. Варианты: `false` `true`
federated_identities псевдонимы: federatedIdentities list / elements=string	Список поставщиков удостоверений пользователя. По умолчанию: `[]`
federation_link псевдонимы: federationLink string	Связь федерации.
first_name псевдонимы: firstName string	Имя пользователя.
force boolean	Если `true`, пользователь может быть удалён и создан заново. Варианты: `false` ← (по умолчанию) `true`
groups list / elements=dictionary	Список групп пользователя. На группы можно ссылаться по имени, например `staff`, или по пути, например `/staff/engineering`. Синтаксис с путём позволяет ссылаться на вложенные группы, что иначе невозможно. Возможность указывать путь появилась в community.general 10.6.0. По умолчанию: `[]`
name string	Имя группы.
state string	Указывает, должен ли пользователь входить в эту группу. Варианты: `"present"` ← (по умолчанию) `"absent"`
http_agent string добавлено в community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
id string	ID пользователя на сервере Keycloak, если известен.
last_name псевдонимы: lastName string	Фамилия пользователя.
origin string	Источник пользователя.
realm string	Имя области, в которой находится клиент. По умолчанию: `"master"`
refresh_token string добавлено в community.general 10.3.0	Токен обновления аутентификации для API Keycloak.
required_actions псевдонимы: requiredActions list / elements=string	Обязательные действия аутентификации пользователя. По умолчанию: `[]`
self string	Самостоятельное администрирование пользователя.
service_account_client_id псевдонимы: serviceAccountClientId string	Описание клиентского приложения.
state string	Указывает, должен ли пользователь существовать. Варианты: `"present"` ← (по умолчанию) `"absent"`
token string добавлено в community.general 3.0.0	Токен аутентификации для API Keycloak.
username string / обязательный	Имя пользователя.
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`).

Примечания

Примечание

Модуль не изменяет ID существующего пользователя.

Примеры

- name: Create a user user1
  community.general.keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
      - type: password
        value: password
        temporary: false
    attributes:
      - name: attr1
        values:
          - value1
        state: present
      - name: attr2
        values:
          - value2
        state: absent
    groups:
      - name: group1
        state: present
    state: present

- name: Re-create a User
  community.general.keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
      - type: password
        value: password
        temporary: false
    attributes:
      - name: attr1
        values:
          - value1
        state: present
      - name: attr2
        values:
          - value2
        state: absent
    groups:
      - name: group1
        state: present
    state: present

- name: Re-create a User
  community.general.keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
      - type: password
        value: password
        temporary: false
    attributes:
      - name: attr1
        values:
          - value1
        state: present
      - name: attr2
        values:
          - value2
        state: absent
    groups:
      - name: group1
        state: present
    state: present
    force: true

- name: Remove User
  community.general.keycloak_user:
    auth_keycloak_url: http://localhost:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    state: absent

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

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

Ключ	Описание
end_state dictionary	Представление пользователя после выполнения модуля. Возвращается: при успешном выполнении
existing dictionary	Представление существующего пользователя. Возвращается: при успешном выполнении
proposed dictionary	Представление предлагаемого пользователя. Возвращается: при успешном выполнении
user_created boolean добавлено в community.general 12.0.0	Указывает, был ли создан пользователь. Возвращается: при успешном выполнении

Авторы

Philippe Gauthier (@elfelip)

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

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