Модуль cyberark.pas.cyberark_user — управление пользователями CyberArk с помощью PAS Web Services SDK.

Примечание

Этот модуль входит в коллекцию cyberark.pas (версия 1.0.39).

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

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

Чтобы использовать её в плейбуке, укажите: cyberark.pas.cyberark_user.

Примечание

Коллекция cyberark.pas будет удалена из Ansible 15 из-за несоответствия требованиям Ansible для включения в состав дистрибутива. Коллекция неоднократно нарушала эти требования, в том числе в части управления репозиторием. Сопровождающие коллекции не ответили на последнее сообщение о нарушении. После удаления коллекцию по-прежнему можно будет установить вручную с помощью ansible-galaxy collection install cyberark.pas. Дополнительные сведения см. в теме обсуждения.

Новое в cyberark.pas 1.0.0

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

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

Управление пользователями CyberArk с помощью PAS Web Services SDK. В настоящее время поддерживаются следующие действия: получение сведений о пользователе, добавление пользователя, обновление пользователя и удаление пользователя.

Параметры

Параметр	Комментарии
authorization list / elements=string	Список параметров авторизации для этого пользователя. Возможные параметры: AddSafes и AuditUsers. Значение по умолчанию обеспечивает обратную совместимость с предыдущими версиями коллекции. По умолчанию: `["AddSafes", "AuditUsers"]`
change_password_on_the_next_logon boolean	Должен ли пользователь изменить пароль при следующем входе в систему. Варианты: `false` ← (по умолчанию) `true`
cyberark_session dictionary / обязательный	Словарь, формируемый при аутентификации в CyberArk и содержащий различные значения для выполнения действий в активном сеансе CyberArk. Пример cyberark_session см. в модуле cyberark.pas.cyberark_authentication.
disabled boolean	Будет ли пользователь отключён. Варианты: `false` ← (по умолчанию) `true`
domain_name string	Имя домена пользователя.
email string
expiry_date string	Дата и время истечения срока действия учётной записи пользователя, после которого она будет отключена.
first_name string	Имя пользователя.
group_name string	Имя группы, в которую будет добавлен пользователь. Вызывает дополнительный поиск в CyberArk. Игнорируется, если используется vault_id. Вызовет ошибку, если группа не найдена или существует несколько групп с таким именем.
initial_password string	Пароль, который новый пользователь будет использовать при первом входе в систему. Этот пароль должен соответствовать требованиям политики паролей. Этот параметр обязателен, если state имеет значение present — добавление пользователя.
last_name string	Фамилия пользователя.
location string	Расположение пользователя в хранилище Vault.
logging_file string	Имя и расположение файла журнала для устранения неполадок. По умолчанию: `"/tmp/ansible_cyberark.log"`
logging_level string	Параметр, задающий уровень подробности диагностических сообщений для значения `logging_file`. Варианты: `"NOTSET"` ← (по умолчанию) `"DEBUG"` `"INFO"`
member_type string	Тип участника.
new_password string	Новый пароль пользователя. Убедитесь, что он соответствует требованиям политики паролей.
state string	Задаёт требуемое состояние пользователя: present — создать пользователя, absent — удалить пользователя. Варианты: `"absent"` `"present"` ← (по умолчанию)
timeout float	Время ожидания данных от сервера до завершения операции. По умолчанию: `10.0`
user_type_name string	Тип пользователя. По умолчанию для параметра используется значение `EPVUser`.
username string / обязательный	Имя пользователя, сведения о котором будут запрошены или которого нужно добавить, обновить либо удалить.
vault_id integer	Идентификатор группы пользователей, в которую нужно добавить пользователя. Имеет приоритет над group_name.

Примеры

- name: Logon to CyberArk Vault using PAS Web Services SDK
  cyberark_authentication:
    api_base_url: https://components.cyberark.local
    use_shared_logon_authentication: true

- name: Create user & immediately add it to a group
  cyberark_user:
    username: username
    initial_password: password
    user_type_name: EPVUser
    change_password_on_the_next_logon: false
    group_name: GroupOfUser
    state: present
    cyberark_session: '{{ cyberark_session }}'

- name: Make sure user is present and reset user credential if present
  cyberark_user:
    username: Username
    new_password: password
    disabled: false
    state: present
    cyberark_session: '{{ cyberark_session }}'

- name: Logoff from CyberArk Vault
  cyberark_authentication:
    state: absent
    cyberark_session: '{{ cyberark_session }}'

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

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

Ключ	Описание
changed boolean	Были ли внесены изменения. Возвращается: всегда
cyberark_user complex	Словарь со свойствами результата. Возвращается: всегда
result dictionary	Свойства пользователя, если state имеет значение present. Возвращается: при успешном выполнении
status_code integer	Код состояния HTTP результата. Возвращается: при успешном выполнении Пример: `200`

Авторы

Edward Nunez (@enunez-cyberark)
Cyberark Bizdev (@cyberark-bizdev)
Erasmo Acosta (@erasmix)
James Stutes (@jimmyjamcabd)

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

© 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/cyberark/pas/cyberark_user_module.html