community.general.keycloak_client_rolemapping 模块 – 允许通过 Keycloak API 管理 Keycloak client_rolemapping

注意

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

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

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

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

community.general 3.5.0 中的新功能

概要

  • 此模块允许您通过 Keycloak REST API 添加、删除或修改 Keycloak client_rolemapping。它需要通过 OpenID Connect 访问 REST API；连接的用户和正在使用的客户端必须具有必要的访问权限。在默认的 Keycloak 安装中，admin-cli 和管理员用户可以工作，具有根据您的需要定制的作用域的单独客户端定义以及具有预期角色的用户也可以工作。

  • 模块选项的名称是 Keycloak API 及其文档中找到的 camelCase 版本的 snake_cased 版本，网址为 https://keycloak.java.net.cn/docs-api/8.0/rest-api/index.html。

  • 属性在 Keycloak API 中是多值的。所有属性都是单个值的列表，并且将由此模块以这种方式返回。您可以在调用模块时传递属性的单个值，这将转换为适合 API 的列表。

  • 更新 client_rolemapping 时，请尽可能将角色 ID 提供给模块。这会删除对 API 的查找，以将名称转换为角色 ID。

参数

参数

注释

auth_client_id

字符串

用于使用 OpenID Connect client_id 向 API 进行身份验证。

默认值： "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

别名：username

字符串

用于 API 访问的身份验证用户名。

cid

字符串

要映射的客户端的 ID。

此参数不是更新或删除 rolemapping 所必需的，但提供它将减少所需的 API 调用次数。

client_id

字符串

要映射的客户端的名称（与 cid 不同）。

此参数是必需的（可以用 cid 替换以减少 API 调用）。

connection_timeout

整数

在 community.general 4.5.0 中添加

控制与 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。

默认值： 10

gid

字符串

要映射的组的 ID。

此参数不是更新或删除 rolemapping 所必需的，但提供它将减少所需的 API 调用次数。

group_name

字符串

要映射的组的名称。

此参数是必需的（可以用 gid 替换以减少 API 调用）。

http_agent

字符串

在 community.general 5.4.0 中添加

配置 HTTP User-Agent 标头。

默认值： "Ansible"

parents

列表 / elements=字典

在 community.general 7.1.0 中添加

要处理的组的父组列表，从上到下排序。

如果您的组是一个子组，并且您没有在 gid 中提供 GID，请设置此项。

id

字符串

通过 ID 标识父级。

比使用 parents[].name 需要更少的 API 调用。

当第一个父级以 ID 形式给出时，可以从任何点开始深层父级链。

请注意，原则上可以同时指定 ID 和名称，但当前实现始终只使用其中一个，且 ID 优先。

名称

字符串

通过名称识别父级。

与使用 parents[].id 在底层将名称映射到 ID 相比，需要更多的内部 API 调用。

当提供仅包含名称的父链时，它必须是完整的，直到最顶层。

请注意，原则上可以同时指定 ID 和名称，但当前实现始终只使用其中一个，且 ID 优先。

域

字符串

此 role_representation 所属的 Keycloak 域。

默认值： "master"

角色

列表 / elements=字典

要映射到组的角色。

id

字符串

此 role_representation 的唯一标识符。

此参数不是更新或删除 role_representation 所必需的，但提供此参数将减少所需的 API 调用次数。

名称

字符串

role_representation 的名称。

仅在创建或更新 role_representation 时才需要此参数。

状态

字符串

client_rolemapping 的状态。

当为 present 时，如果 client_rolemapping 尚不存在，则会创建它；如果存在，则会使用您提供的参数更新它。

当为 absent 时，如果 client_rolemapping 存在，则会将其删除。

选项

  • "present" ← (默认)

  • "absent"

令牌

字符串

在 community.general 3.0.0 中添加

Keycloak API 的身份验证令牌。

validate_certs

布尔值

验证 TLS 证书（请勿在生产环境中禁用此项）。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全

可以在 check_mode 中运行，并返回更改状态预测，而无需修改目标。

diff_mode

支持：完全

当处于 diff 模式时，将返回有关已更改内容（或在 check_mode 中可能需要更改的内容）的详细信息。

示例

- name: Map a client role to a group, authentication with credentials
  community.general.keycloak_client_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: present
    client_id: client1
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Map a client role to a group, authentication with token
  community.general.keycloak_client_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    state: present
    client_id: client1
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Map a client role to a subgroup, authentication with token
  community.general.keycloak_client_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    token: TOKEN
    state: present
    client_id: client1
    group_name: subgroup1
    parents:
      - name: parent-group
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

- name: Unmap client role from a group
  community.general.keycloak_client_rolemapping:
    realm: MyCustomRealm
    auth_client_id: admin-cli
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    state: absent
    client_id: client1
    group_name: group1
    roles:
      - name: role_name1
        id: role_id1
      - name: role_name2
        id: role_id2
  delegate_to: localhost

返回值

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

键

描述

end_state

字典

模块执行后客户端角色映射的表示。

示例已截断。

已返回：成功时

示例： {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

existing

字典

现有客户端角色映射的表示。

示例已截断。

已返回：始终

示例： {"adminUrl": "http://www.example.com/admin_url", "attributes": {"request.object.signature.alg": "RS256"}}

msg

字符串

关于采取了什么操作的消息。

已返回：始终

示例： "角色 role1 已分配给 组 group1。"

proposed

字典

提议的客户端角色映射的表示。

已返回：始终

示例： {"clientId": "test"}

作者

  • Gaëtan Daubresse (@Gaetan2907)