Spec-Zone.ru › Ansible 2.5

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
Местоположение хранилища для пользователя.
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': {'type': 'dict', 'description': 'свойства пользователя, когда состояние present', 'returned': 'success'}}
status_code
int
успех
Код HTTP статуса результата

Пример:
200


Статус

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

Автор

  • 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.5/modules/cyberark_user_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API