cyberark_user - Модуль для управления пользователями CyberArk с использованием SDK PAS Web Services
Новое в версии 2.4.
Обзор
- Управление пользователями CyberArk с использованием SDK PAS Web Services. В настоящее время поддерживаются следующие действия: Получение данных пользователя, Добавление пользователя, Обновление пользователя, Удаление пользователя.
Параметры
| параметр | обязательный | по умолчанию | выбор | комментарии |
|---|---|---|---|---|
| change_password_on_the_next_logon | нет | нет |
| Требуется ли пользователю сменить пароль при следующей авторизации. Допустимые значения = true/false. |
| cyberark_session | да | Словарь, устанавливаемый модулем аутентификации CyberArk, содержащий различные значения для выполнения действий в сессии CyberArk. Для примера использования cyberark_session, обратитесь к модулю cyberark_authentication. | ||
| disabled | нет | нет |
| Будет ли пользователь заблокирован. Допустимые значения = true/false. |
| email | нет | Электронный адрес пользователя. | ||
| expiry_date | нет | Дата и время, когда учетная запись пользователя истечёт и будет заблокирована. | ||
| first_name | нет | Имя пользователя. | ||
| group_name | нет | Имя группы, к которой будет добавлен пользователь. | ||
| initial_password | нет | Пароль, который новый пользователь будет использовать при первой авторизации. Этот пароль должен соответствовать требованиям политики паролей. Параметр требуется, если параметр state присутствует (Добавление пользователя). | ||
| last_name | нет | Фамилия пользователя. | ||
| location | нет | Местоположение хранилища Vault для пользователя. | ||
| new_password | нет | Обновленный пароль пользователя. Убедитесь, что этот пароль соответствует требованиям политики паролей. | ||
| state | нет | present |
| Указывает состояние пользователя: 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': {'type': 'dict', 'description': 'свойства пользователя, когда state is present', 'returned': 'success'}} |
| status_code | Код HTTP-статуса результата | успех | int | 200 |
Статус
Этот модуль помечен как превью, что означает, что гарантии обратной совместимости интерфейса нет.
Для получения помощи в разработке модулей, если вы так желаете, прочитайте Информация сообщества и участие в разработке, Тестирование Ansible и Разработка модулей.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/cyberark_user_module.html
