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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cyberark.pas.

Чтобы использовать её в плейбуке, укажите: cyberark.pas.cyberark_authentication.

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

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

Краткое описание

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

Параметры

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

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

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

Ключ	Описание
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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cyberark/pas/cyberark_authentication_module.html