cyberark.pas.cyberark_authentication – Аутентификация в CyberArk с использованием PAS Web Services SDK.
Примечание
Этот плагин входит в состав коллекции cyberark.pas (версия 1.0.5).
Для его установки используйте: ansible-galaxy collection install cyberark.pas.
Чтобы использовать его в книге задач, укажите: cyberark.pas.cyberark_authentication.
Новое в версии 2.4: модуля cyberark.pas
Описание
- Авторизуется в хранилище CyberArk с использованием Privileged Account Security Web Services SDK и создаёт фактор сессии, который может быть использован другими модулями. Он возвращает факт Ansible под названием cyberark_session. Каждый модуль может использовать этот факт в качестве параметра
cyberark_session.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| api_base_url строка | Строка, содержащая базовый URL-адрес сервера, на котором размещены веб-службы CyberArk Privileged Account Security SDK. | |
| connection_number целое число | Для поддержки нескольких подключений для одного пользователя укажите разные значения для этого параметра. | |
| cyberark_session словарь | Словарь, заданный модулем аутентификации CyberArk, содержащий различные значения для выполнения действий в сессии подключенного к CyberArk. | |
| new_password строка | Новый пароль пользователя. Этот параметр является необязательным и позволяет изменить пароль. | |
| password строка | Пароль пользователя. | |
| state строка |
| Указывает, должен ли быть добавлен/удален вход/выход в систему аутентификации и cyberark_session. |
| use_radius_authentication логическое значение |
| Указывает, будут ли пользователи аутентифицироваться через RADIUS-сервер. Допустимые значения — true/false. |
| use_shared_logon_authentication логическое значение |
| Указывает, будет ли использоваться аутентификация Shared Logon. |
| username строка | Имя пользователя, который войдёт в хранилище. | |
| validate_certs логическое значение |
| Если false, сертификаты SSL не будут проверены. Это следует установить только в false, используемых на сайтах под собственным контролем с использованием самозаверяющих сертификатов. |
Примеры
- name: Logon - use_shared_logon_authentication
cyberark_authentication:
api_base_url: "{{ web_services_base_url }}"
use_shared_logon_authentication: yes
- name: Logon - 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 сложный тип | success | Факты аутентификации. | |
| api_base_url строка | всегда | Базовый URL для API-запросов. Возвращается в cyberark_session, поэтому его можно использовать в последующих вызовах. | |
| token строка | всегда | Токен, идентифицирующий сеанс, закодированный в BASE 64. | |
| use_shared_logon_authentication логическое значение | всегда | Указывает, использовалась ли аутентификация Shared Logon для создания сессии. | |
| validate_certs логическое значение | всегда | Указывает, должны ли быть проверены сертификаты SSL. | |
Авторы
- Edward Nunez (@enunez-cyberark) CyberArk BizDev
- Cyberark Bizdev (@cyberark-bizdev)
- Erasmo Acosta (@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.10/collections/cyberark/pas/cyberark_authentication_module.html
