community.general.keycloak_user 模块 – 在 Keycloak 中创建和配置用户

注意

此模块是 community.general 集合 (版本 10.1.0) 的一部分。

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

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

要在 playbook 中使用它，请指定： community.general.keycloak_user。

community.general 7.1.0 中的新增功能

概要

• 此模块创建、删除或更新 Keycloak 用户。

参数

参数	注释
access 字典	列出用户访问权限。
attributes 列表 / 元素=字典	用户属性列表。
name 字符串	属性名称。
state 字符串	控制属性是否存在。 选项 "present" ← (默认) "absent"
values 列表 / 元素=字符串	属性的值列表。
auth_client_id 字符串	用于使用 API 进行身份验证的 OpenID Connect client_id。 默认值： "admin-cli"
auth_client_secret 字符串	与 auth_client_id (如果需要)一起使用的客户端密钥。
auth_keycloak_url 别名：url 字符串 / 必需	Keycloak 实例的 URL。
auth_password 别名：password 字符串	用于 API 访问身份验证的密码。
auth_realm 字符串	用于 API 访问身份验证的 Keycloak realm 名称。
auth_username 字符串	用于 API 访问身份验证的用户名。
client_consents 别名：clientConsents 列表 / 元素=字典	客户端身份验证类型。 默认值： []
client_id 别名：clientId 字符串 / 必需	客户端角色的客户端 ID。不是客户端的技术 ID。
roles 列表 / 元素=字符串 / 必需	要分配给用户的客户端角色列表。
connection_timeout 整数 community.general 4.5.0 中新增	控制到 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。 默认值： 10
credentials 列表 / 元素=字典	用户凭据。 默认值： []
temporary 布尔值	如果 true，则要求用户在下一次登录时重置其凭据。 选项 false ← (默认) true
type 字符串 / 必需	凭据类型。
value 字符串 / 必需	凭据的值。
disableable_credential_types 别名：disableableCredentialTypes 列表 / 元素=字符串	列出用户凭据类型。 默认值： []
email 字符串	用户邮箱。
email_verified 别名：emailVerified 布尔值	检查用户邮箱的有效性。 选项 false ← (默认) true
enabled 布尔值	启用用户。 选项 false true
federated_identities 别名：federatedIdentities 列表 / 元素=字符串	用户的 IDP 列表。 默认值： []
federation_link 别名：federationLink 字符串	联合链接。
first_name 别名：firstName 字符串	用户的姓名。
force 布尔值	如果 true，允许删除用户并重新创建它。 选项 false ← (默认) true
groups 列表 / 元素=字典	用户的组列表。 默认值： []
name 字符串	组的名称。
state 字符串	控制用户是否必须是该组的成员。 选项 "present" ← (默认) "absent"
http_agent 字符串 community.general 5.4.0 中新增	配置 HTTP User-Agent 标头。 默认值： "Ansible"
id 字符串	如果已知，则为 Keycloak 服务器上用户的 ID。
last_name 别名：lastName 字符串	用户的姓氏。
origin 字符串	用户来源。
realm 字符串	客户端所在的 realm 的名称。 默认值： "master"
required_actions 别名：requiredActions 列表 / 元素=字符串	RequiredActions 用户身份验证。 默认值： []
self 字符串	用户自我管理。
service_account_client_id 别名：serviceAccountClientId 字符串	客户端应用程序的描述。
state 字符串	控制用户是否存在。 选项 "present" ← (默认) "absent"
token 字符串 community.general 3.0.0 中新增	Keycloak API 的身份验证令牌。
username 字符串 / 必需	用户的用户名。
validate_certs 布尔值	验证 TLS 证书（不要在生产环境中禁用此选项）。 选项 false true ← (默认)

属性

属性	支持	描述
检查模式	支持：完全支持	可以在check_mode模式下运行，并返回更改状态预测，而无需修改目标。
差异模式	支持：完全支持	在差异模式下，将返回有关已更改内容（或可能需要在check_mode模式下更改的内容）的详细信息。

备注

注意

• 此模块不会修改现有用户的用户 ID。

示例

- name: Create a user user1
  community.general.keycloak_user:
    auth_keycloak_url: https://:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
        - type: password
          value: password
          temporary: false
    attributes:
        - name: attr1
          values:
            - value1
          state: present
        - name: attr2
          values:
            - value2
          state: absent
    groups:
        - name: group1
          state: present
    state: present

- name: Re-create a User
  community.general.keycloak_user:
    auth_keycloak_url: https://:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
        - type: password
          value: password
          temporary: false
    attributes:
        - name: attr1
          values:
            - value1
          state: present
        - name: attr2
          values:
            - value2
          state: absent
    groups:
        - name: group1
          state: present
    state: present

- name: Re-create a User
  community.general.keycloak_user:
    auth_keycloak_url: https://:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    firstName: user1
    lastName: user1
    email: user1
    enabled: true
    emailVerified: false
    credentials:
        - type: password
          value: password
          temporary: false
    attributes:
        - name: attr1
          values:
            - value1
          state: present
        - name: attr2
          values:
            - value2
          state: absent
    groups:
        - name: group1
          state: present
    state: present
    force: true

- name: Remove User
  community.general.keycloak_user:
    auth_keycloak_url: https://:8080/auth
    auth_username: admin
    auth_password: password
    realm: master
    username: user1
    state: absent

返回值

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

键	描述
changed 布尔值	如果操作更改了 Keycloak 服务器上的用户，则返回true，否则返回false。 返回：始终返回
end_state 字典	模块执行后用户的表示 返回：成功时返回
existing 字典	现有用户的表示。 返回：成功时返回
msg 字符串	关于采取了什么操作的消息。 返回：始终返回 示例："User f18c709c-03d6-11ee-970b-c74bf2721112 created"
proposed 字典	建议用户的表示。 返回：成功时返回

作者

• Philippe Gauthier (@elfelip)

资源链接

• 问题追踪
• 代码仓库
• 寻求帮助
• 提交错误报告
• 请求功能
• 通信