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

Примечание

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

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

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

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

Новый в community.general 7.1.0

Обзор
Параметры
Атрибуты
Примечания
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Комментарии
access словарь	список доступа пользователя.
attributes список / элементы=словарь	Список атрибутов пользователя.
name строка	Имя атрибута.
state строка	Управление тем, должен ли существовать атрибут или нет. Варианты: `"present"` ← (по умолчанию) `"absent"`
values список / элементы=строка	Значения атрибута в виде списка.
auth_client_id строка	Открытый идентификатор подключения `client_id` для аутентификации с API. По умолчанию: `"admin-cli"`
auth_client_secret строка	Секретный ключ клиента для использования совместно с `auth_client_id` (если требуется).
auth_keycloak_url псевдонимы: url строка / обязательно	URL-адрес экземпляра Keycloak.
auth_password псевдонимы: пароль строка	Пароль для аутентификации с доступом к API.
auth_realm строка	Имя области Keycloak для аутентификации с доступом к API.
auth_username строка	Имя пользователя для аутентификации с доступом к API.
client_consents псевдонимы: clientConsents список / элементы=словарь	Тип аутентификатора клиента. По умолчанию: `[]`
client_id псевдонимы: clientId строка / обязательно	Идентификатор клиента роли. Не технический ID клиента.
roles список / элементы=строка / обязательно	Список ролей клиента, которые необходимо назначить пользователю.
connection_timeout целое число добавлено в community.general 4.5.0	Управляет временем ожидания HTTP-соединений (в секундах) с API Keycloak. По умолчанию: `10`
credentials список / элементы=словарь	Данные учетной записи пользователя. По умолчанию: `[]`
temporary булево	Если `true`, пользователи должны сбросить свои данные учетной записи при следующем входе в систему. Варианты: `false` ← (по умолчанию) `true`
type строка / обязательно	Тип данных учетной записи.
value строка / обязательно	Значение данных учетной записи.
disableable_credential_types псевдонимы: disableableCredentialTypes список / элементы=строка	список типов данных учетной записи пользователя. По умолчанию: `[]`
email строка	Электронный адрес пользователя.

END_OF_DOCUMENT_MARKER

email_verified aliases: emailVerified boolean	Проверьте корректность электронного адреса пользователя. Выбоpы: `false` ← (по умолчанию) `true`
enabled boolean	Пользователь включен. Выбоpы: `false` `true`
federated_identities aliases: federatedIdentities list / elements=string	Список IDП пользователя. По умолчанию: `[]`
federation_link aliases: federationLink string	Ссылка на федерацию.
first_name aliases: firstName string	Имя пользователя.
force boolean	Если `true`, позволяет удалить пользователя и создать его заново. Выбоpы: `false` ← (по умолчанию) `true`
groups list / elements=dictionary	Список групп для пользователя. По умолчанию: `[]`
name string	Имя группы.
state string	Управление тем, должен ли пользователь быть членом этой группы или нет. Выбоpы: `"present"` ← (по умолчанию) `"absent"`
http_agent string added in community.general 5.4.0	Настраивает заголовок HTTP User-Agent. По умолчанию: `"Ansible"`
id string	Идентификатор пользователя на сервере Keycloak, если известен.
last_name aliases: lastName string	Фамилия пользователя.
origin string	Происхождение пользователя.
realm string	Имя домена, в котором находится клиент. По умолчанию: `"master"`
required_actions aliases: requiredActions list / elements=string	Требуемые действия авторизации пользователя. По умолчанию: `[]`
self string	Самообслуживание пользователя.
service_account_client_id aliases: serviceAccountClientId string	Описание клиентского приложения.
state string	Управление существованием пользователя. Выбоpы: `"present"` ← (по умолчанию) `"absent"`
token string added in community.general 3.0.0	Токен аутентификации для API Keycloak.
username string / обязательно	Имя пользователя.

END_OF_DOCUMENT_MARKER

validate_certs

boolean

Проверять сертификаты TLS (не отключайте эту опцию в рабочей среде).

Варианты:

false
true ← (по умолчанию)

Атрибуты

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

Примечания

Примечание

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

Примеры

- 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

Значения возврата

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

Ключ	Описание
changed boolean	Возвращает `true`, если операция изменила пользователя на сервере Keycloak, `false` в противном случае. Возвращается: всегда
end_state словарь	Представление пользователя после выполнения модуля Возвращается: при успехе
existing словарь	Представление существующего пользователя. Возвращается: при успехе
msg строка	Сообщение о том, какое действие было выполнено. Возвращается: всегда Пример: `"User f18c709c-03d6-11ee-970b-c74bf2721112 created"`
proposed словарь	Представление предлагаемого пользователя. Возвращается: при успехе

Авторы

Philippe Gauthier (@elfelip)

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

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