Модуль cyberark.pas.cyberark_authentication — Авторизация в CyberArk с помощью SDK PAS Web Services.

Примечание

Этот модуль входит в коллекцию cyberark.pas (версия 1.0.27).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cyberark.pas.

Для использования в книге задач укажите: cyberark.pas.cyberark_authentication.

Добавлена в cyberark.pas 1.0.0

Описание
Параметры
Примеры
Возвращаемые значения

Описание

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

Параметры

Параметр	Комментарии
api_base_url строка	Строка, содержащая базовый URL-адрес сервера, на котором размещен SDK Web Services для CyberArk Privileged Account Security.
concurrentSession булево	Разрешить или запретить одновременные сессии для одного пользователя. Варианты: `false` ← (по умолчанию) `true`
connection_number целое число	Для поддержки нескольких подключений для одного пользователя укажите разные значения для этого параметра.
cyberark_session словарь	Словарь, установленный модулем аутентификации CyberArk, содержащий различные значения для выполнения действий в сессии CyberArk.
new_password строка	Новый пароль пользователя. Этот параметр необязателен и позволяет изменить пароль.
password строка	Пароль пользователя.
state строка	Указывает, должна ли быть добавлена/удалена запись в журнале аутентификации (логин/выход) и факт сессии cyberark_session. Варианты: `"present"` ← (по умолчанию) `"absent"`
timeout целое число	Устанавливает тайм-аут для процесса авторизации в Cyberark. По умолчанию: `10`
use_cyberark_authentication булево	Использовать ли аутентификацию LDAP. Варианты: `false` ← (по умолчанию) `true`
use_ldap_authentication булево	Использовать ли аутентификацию LDAP. Варианты: `false` ← (по умолчанию) `true`
use_radius_authentication булево	Авторизовывать ли пользователей через RADIUS-сервер. Допустимые значения true/false. Варианты: `false` ← (по умолчанию) `true`
use_windows_authentication булево	Использовать ли Windows для аутентификации. Варианты: `false` ← (по умолчанию) `true`
username строка	Имя пользователя, который будет авторизован в хранилище.
validate_certs булево	Если `false`, сертификаты SSL не будут проверены. Это должно быть установлено только в `false` на сайтах, контролируемых лично, использующих самозаверяющие сертификаты. Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Logon - use_shared_logon_authentication
  cyberark_authentication:
    api_base_url: "{{ web_services_base_url }}"
    use_shared_logon_authentication: true

- 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: false

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

END_OF_DOCUMENT_MARKER

Значения возврата

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

Ключ	Описание
cyberark_session complex	Данные об авторизации. Возвращается: успех
api_base_url string	Базовый URL для API-вызовов. Возвращается в cyberark_session, поэтому может использоваться в последующих вызовах. Возвращается: всегда
token string	Токен, идентифицирующий сеанс, закодирован в BASE 64. Возвращается: всегда
use_shared_logon_authentication boolean	Использовалась ли для создания сеанса аутентификация Shared Logon. Возвращается: всегда
validate_certs boolean	Должны ли проверяться сертификаты SSL. Возвращается: всегда

Авторы

Edward Nunez (@enunez-cyberark)
Cyberark Bizdev (@cyberark-bizdev)

Ссылки на сборку

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cyberark/pas/cyberark_authentication_module.html