cyberark_authentication - Модуль для аутентификации в CyberArk Vault с использованием PAS Web Services SDK

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

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

Описание

Производит аутентификацию в хранилище CyberArk Vault с использованием Privileged Account Security Web Services SDK и создает факт сессии, который может использоваться другими модулями. Возвращает факт Ansible, называемый cyberark_session. Каждый модуль может использовать этот факт в качестве параметра cyberark_session.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_base_url		Строка, содержащая базовый URL-адрес сервера, на котором размещены веб-службы CyberArk Privileged Account Security SDK.
cyberark_session		Словарь, устанавливаемый модулем аутентификации CyberArk, содержащий различные значения для выполнения действий в залогиненной сессии CyberArk.
new_password		Новый пароль пользователя. Этот параметр необязателен и позволяет изменить пароль.
password		Пароль пользователя.
state	Варианты: present ← absent	Определяет, должна ли быть добавлена/удалена запись об аутентификации (логин/логин-аут) и cyberark_session.
use_radius_authentication bool	Варианты: нет ← да	Указывает, будут ли пользователи аутентифицироваться через сервер RADIUS. Допустимые значения true/false.
use_shared_logon_authentication bool	Варианты: нет ← да	Указывает, будет ли использоваться аутентификация Shared Logon.
username		Имя пользователя, который будет войти в Vault.
validate_certs bool	Варианты: нет да ←	Если `false`, сертификаты SSL не будут проверяться. Это значение следует устанавливать только в `false` на сайтах с самозаверенными сертификатами.

Примеры

- name: Logon to CyberArk Vault using PAS Web Services SDK - use_shared_logon_authentication
  cyberark_authentication:
    api_base_url: "{{ web_services_base_url }}"
    use_shared_logon_authentication: yes

- name: Logon to CyberArk Vault using PAS Web Services SDK - Not use_shared_logon_authentication
  cyberark_authentication:
    api_base_url: "{{ web_services_base_url }}"
    username: "{{ password_object.password }}"
    password: "{{ password_object.passprops.username }}"
    use_shared_logon_authentication: no

- name: Logoff from CyberArk Vault
  cyberark_authentication:
    state: absent
    cyberark_session: "{{ cyberark_session }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
cyberark_session dict	success	Факты аутентификации. Пример: {'api_base_url': {'description': 'Базовый URL для API-запросов. Возвращается в cyberark_session, чтобы его можно было использовать в последующих вызовах.', 'type': 'string', 'returned': 'всегда'}, 'token': {'description': 'Токен, идентифицирующий сессию, закодированный в BASE 64.', 'type': 'string', 'returned': 'всегда'}, 'use_shared_logon_authentication': {'description': 'Указывает, была ли использована аутентификация Shared Logon для установления сессии.', 'type': 'bool', 'returned': 'всегда'}, 'validate_certs': {'description': 'Указывает, следует ли проверять сертификаты SSL.', 'type': 'bool', 'returned': 'всегда'}}

Статус

Этот модуль помечен как 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_authentication_module.html