cyberark_user – Модуль управления пользователями CyberArk с использованием SDK PAS Web Services

Новая версия с 2.4.

Обзор
Параметры
Примеры
Возвращаемые значения
Статус

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
change_password_on_the_next_logon boolean	Варианты: нет ← да	Требуется ли пользователю сменить пароль при следующей авторизации. Допустимые значения: true/false.
cyberark_session - / обязательно		Словарь, заданный с помощью проверки подлинности CyberArk, содержащий различные значения для выполнения действий в залогиненной сессии CyberArk. Для примера использования cyberark_session см. модуль cyberark_authentication.
disabled boolean	Варианты: нет ← да	Будет ли пользователь отключен. Допустимые значения: true/false.
email -		Электронный адрес пользователя.
expiry_date -		Дата и время, когда учетная запись пользователя истечет и станет недоступной.
first_name -		Имя пользователя.
group_name -		Имя группы, к которой будет добавлен пользователь.
initial_password -		Пароль, который новый пользователь будет использовать при первом входе. Этот пароль должен соответствовать требованиям политики паролей. Этот параметр требуется, когда параметр state имеет значение present — Добавление пользователя.
last_name -		Фамилия пользователя.
location -		Расположение хранилища для пользователя.
new_password -		Обновленный пароль пользователя. Убедитесь, что этот пароль соответствует требованиям политики паролей.
state -	Варианты: присутствует ← отсутствует	Указывает состояние, необходимое для пользователя при добавлении (present) или удалении (absent).
user_type_name -	По умолчанию: "EPVUser"	Тип пользователя.
username - / обязательно		Имя пользователя, который будет запрошен (для получения данных), добавлен, обновлен или удален.

Примеры

- 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: "GroupOfUsers"
    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 словарь	всегда	Словарь, содержащий свойства результата. Пример: {'result': {'description': 'свойства пользователя, когда state — присутствует', 'type': 'dict', 'returned': 'success'}}
status_code целое число	успех	Код HTTP статуса результата Пример: 200

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [сообщество]

Авторы

Edward Nunez @ CyberArk BizDev (@enunez-cyberark, @cyberark-bizdev, @erasmix)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/cyberark_user_module.html