cyberark.pas.cyberark_user 模块 – 使用 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_user。

cyberark.pas 1.0.0 中的新增功能

概要

• 使用 PAS Web Services SDK 管理 CyberArk 用户，目前支持以下操作：获取用户详细信息、添加用户、更新用户、删除用户。

参数

参数	注释
authorization 列表 / 元素=字符串	此用户的授权选项列表。 选项包括 AddSafes 和 AuditUsers 默认值提供与旧版本集合的向后兼容性 默认值： ["AddSafes", "AuditUsers"]
change_password_on_the_next_logon 布尔值	用户是否必须在下次登录时更改密码。 选项 false ← (默认) true
cyberark_session 字典 / 必需	由 CyberArk 身份验证设置的字典，包含在已登录的 CyberArk 会话上执行操作的不同值，请参阅 cyberark.pas.cyberark_authentication 模块以了解 cyberark_session 的示例。
disabled 布尔值	用户是否将被禁用。 选项 false ← (默认) true
domain_name 字符串	用户域的名称。
email 字符串	用户的电子邮件地址。
expiry_date 字符串	用户帐户过期并被禁用的日期和时间。
first_name 字符串	用户的姓。
group_name 字符串	将用户添加到其中的组的名称。 在 CyberArk 中导致额外的查找 如果使用 vault_id，则将被忽略 如果组不存在或存在多个具有该名称的组，则将导致失败
initial_password 字符串	新用户第一次登录时将使用的密码。 此密码必须符合密码策略要求。 当 state 为 present（添加用户）时，此参数是必需的。
last_name 字符串	用户的名。
location 字符串	用户的 Vault 位置。
logging_file 字符串	设置日志文件名和位置以进行故障排除日志记录。 默认值： "/tmp/ansible_cyberark.log"
logging_level 字符串	用于定义向 logging_file 值输出的故障排除级别。 选项 "NOTSET" ← (默认) "DEBUG" "INFO"
member_type 字符串	成员类型。
new_password 字符串	用户更新的密码。确保此密码符合密码策略要求。
state 字符串	指定用户所需的状态，present 用于创建用户，absent 用于删除用户。 选项 "absent" "present" ← (默认)
timeout 浮点数	在放弃之前等待服务器发送数据的时间 默认值： 10.0
user_type_name 字符串	用户的类型。 此参数默认为 EPVUser。
username 字符串 / 必需	将被查询（详细信息）、添加、更新或删除的用户的名称。
vault_id 整数	将用户添加到其中的用户组的 ID 优先于 group_name

示例

- name: Logon to CyberArk Vault using PAS Web Services SDK
  cyberark_authentication:
    api_base_url: https://components.cyberark.local
    use_shared_logon_authentication: true

- name: Create user & immediately add it to a group
  cyberark_user:
    username: username
    initial_password: password
    user_type_name: EPVUser
    change_password_on_the_next_logon: false
    group_name: GroupOfUser
    state: present
    cyberark_session: '{{ cyberark_session }}'

- name: Make sure user is present and reset user credential if present
  cyberark_user:
    username: Username
    new_password: password
    disabled: false
    state: present
    cyberark_session: '{{ cyberark_session }}'

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

返回值

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

键	描述
changed 布尔值	是否进行了更改。 返回值： 始终
cyberark_user 复杂类型	包含结果属性的字典。 返回值： 始终
result 字典	state 为 present 时的用户属性 返回值： 成功
status_code 整数	结果 HTTP 状态代码 返回值： 成功 示例： 200

作者

• Edward Nunez (@enunez-cyberark)

• Cyberark Bizdev (@cyberark-bizdev)

• Erasmo Acosta (@erasmix)

• James Stutes (@jimmyjamcabd)

集合链接

• 问题跟踪器
• 代码库 (源代码)