cyberark.pas.cyberark_authentication 模块 – 使用 PAS Web Services SDK 进行 CyberArk 身份验证。

注意

此模块是 cyberark.pas 集合（版本 1.0.30）的一部分。

如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install cyberark.pas。

要在 playbook 中使用它，请指定：cyberark.pas.cyberark_authentication。

cyberark.pas 1.0.0 中的新功能

概要

• 使用特权帐户安全 Web Services SDK 对 CyberArk Vault 进行身份验证，并创建一个可供其他模块使用的会话事实。它返回一个名为 cyberark_session 的 Ansible 事实。每个模块都可以使用此事实作为 cyberark_session 参数。

参数

参数	注释
api_base_url 字符串	一个字符串，包含托管 CyberArk 特权帐户安全 Web Services SDK 的服务器的基本 URL。
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 字符串	将登录到 Vault 的用户的名称。
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 }}"

返回值

常见返回值记录在此处，以下是此模块独有的字段

键	描述
cyberark_session 复杂	身份验证事实。 返回：成功
api_base_url 字符串	API 调用的基本 URL。在 cyberark_session 中返回，以便可以在后续调用中使用。 返回：始终
token 字符串	标识会话的令牌，以 BASE 64 编码。 返回：始终
use_shared_logon_authentication 布尔值	是否使用共享登录身份验证来建立会话。 返回：始终
validate_certs 布尔值	是否应验证 SSL 证书。 返回：始终

作者

• Edward Nunez (@enunez-cyberark)

• Cyberark Bizdev (@cyberark-bizdev)

集合链接

• 问题跟踪器
• 存储库（源）