cyberark.pas.cyberark_user – Управление пользователями CyberArk с помощью веб-служб PAS SDK.
Примечание
Этот плагин входит в коллекцию cyberark.pas (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install cyberark.pas.
Чтобы использовать его в плейбуке, укажите: cyberark.pas.cyberark_user.
Новое в версии 2.4: плагина cyberark.pas
Обзор
- Управление пользователями CyberArk с помощью веб-служб PAS SDK. В настоящее время поддерживаются следующие действия: получение данных пользователя, добавление пользователя, обновление пользователя, удаление пользователя.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| change_password_on_the_next_logon boolean |
| Требуется ли пользователю изменить пароль при следующей авторизации. |
| cyberark_session словарь / обязательный | Словарь, устанавливаемый системой аутентификации CyberArk, содержащий различные значения для выполнения действий с залогиненной сессией CyberArk. См. модуль cyberark_authentication для примера cyberark_session. | |
| disabled boolean |
| Будет ли пользователь отключен. |
| email строка | Адрес электронной почты пользователя. | |
| expiry_date строка | Дата и время, когда учетная запись пользователя истечет и будет отключена. | |
| first_name строка | Имя пользователя. | |
| group_name строка | Имя группы, к которой будет добавлен пользователь. | |
| initial_password строка | Пароль, который новый пользователь будет использовать при первом входе. Этот пароль должен соответствовать требованиям политики паролей. Этот параметр обязателен, когда состояние задано — Добавить пользователя. | |
| last_name строка | Фамилия пользователя. | |
| location строка | Местоположение хранилища для пользователя. | |
| logging_file строка | По умолчанию: "/tmp/ansible_cyberark.log" | Установка имени и расположения файла журнала для отладки. |
| logging_level строка / обязательный |
| Параметр, используемый для определения уровня вывода отладочной информации в logging_file. |
| new_password строка | Обновленный пароль пользователя. Убедитесь, что этот пароль соответствует требованиям политики паролей. | |
| state строка |
| Указывает необходимое состояние для пользователя: присутствует для создания пользователя, отсутствует для удаления пользователя. |
| 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: yes
- 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: no
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: no
state: present
cyberark_session: '{{ cyberark_session }}'
- name: Logoff from CyberArk Vault
cyberark_authentication:
state: absent
cyberark_session: '{{ cyberark_session }}'
Возвращаемые значения
Общие значения возврата описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| changed boolean | всегда | Были ли внесены изменения. | |
| cyberark_user сложный | всегда | Словарь, содержащий свойства результата. | |
| result словарь | успех | Свойства пользователя при состоянии присутствует | |
| status_code целое число | успех | Код состояния HTTP результата. Пример: 200 | |
Авторы
- Edward Nunez (@enunez-cyberark)
- Cyberark Bizdev (@cyberark-bizdev)
- Erasmo Acosta (@erasmix)
- James Stutes (@jimmyjamcabd)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cyberark/pas/cyberark_user_module.html
