cyberark.pas.cyberark_user модуль – Управление пользователями CyberArk с помощью SDK веб-служб PAS.

Примечание

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

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

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

Для использования в playbook укажите: cyberark.pas.cyberark_user.

Новая функция в cyberark.pas 1.0.0

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

Обзор

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

END_OF_DOCUMENT_MARKER

Параметры

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

Авторы

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

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

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