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

Новый в версии 2.4.

Обзор
Параметры
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
change_password_on_the_next_logon bool	Варианты: нет ← да	Требуется ли пользователю изменить пароль при следующей авторизации. Допустимые значения = true/false.
cyberark_session обязательно		Словарь, устанавливаемый при аутентификации CyberArk, содержащий различные значения для выполнения действий в сеансе CyberArk. Для примера использования cyberark_session см. модуль cyberark_authentication.
disabled bool	Варианты: нет ← да	Будет ли пользователь отключен. Допустимые значения = true/false.
email		Электронный адрес пользователя.
expiry_date		Дата и время, когда учетная запись пользователя истекает и становится неактивной.
first_name		Имя пользователя.
group_name		Имя группы, к которой будет добавлен пользователь.
initial_password		Пароль, который новый пользователь будет использовать при первой авторизации. Этот пароль должен соответствовать требованиям политики паролей. Этот параметр требуется, когда присутствует параметр state -- Добавление пользователя.
last_name		Фамилия пользователя.
location		Расположение хранилища для пользователя.
new_password		Обновленный пароль пользователя. Убедитесь, что этот пароль соответствует требованиям политики паролей.
state	Варианты: present ← absent	Указывает состояние, необходимое для пользователя при создании (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 bool	всегда	Были ли внесены изменения.
cyberark_user dict	всегда	Словарь, содержащий свойства результата. Пример: {'result': {'description': 'свойства пользователя, когда состояние present', 'type': 'dict', 'returned': 'success'}}
status_code int	успешно	Код HTTP статуса результата Пример: 200

Статус

Этот модуль помечен как preview, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как community, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.

Список других модулей, также поддерживаемых сообществом 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.6/modules/cyberark_user_module.html