community.general.keycloak_authz_authorization_scope 模块 – 允许通过 Keycloak API 管理 Keycloak 客户端授权范围

注意

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

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

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

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

community.general 6.6.0 中的新增功能

概要

  • 此模块允许通过 Keycloak REST API 管理 Keycloak 客户端授权范围。只有在客户端启用了授权的情况下，授权范围才可用。

  • 此模块需要通过 OpenID Connect 访问 REST API；连接的用户和正在使用的领域必须具有必要的访问权限。在默认的 Keycloak 安装中，admin-cli 和管理员用户可以工作，使用根据您的需求定制的范围和具有预期角色的用户定义单独的领域也可以。

  • 模块选项的名称是 Keycloak 使用的 camelCase 选项的 snake_cased 版本。Keycloak 项目尚未正式记录授权服务路径和有效负载。 https://www.puppeteers.net/blog/keycloak-authorization-services-rest-api-paths-and-payload/

参数

参数

注释

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 领域名称。

auth_username

别名：username

字符串

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

client_id

字符串 / 必需

应该具有授权范围的 Keycloak 客户端的 clientId。

这通常是 Keycloak 客户端的可读名称。

connection_timeout

整数

在 community.general 4.5.0 中添加

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

默认值： 10

display_name

字符串

授权范围的显示名称。

http_agent

字符串

在 community.general 5.4.0 中添加

配置 HTTP User-Agent 标头。

默认值： "Ansible"

icon_uri

字符串

授权范围的图标 URI。

name

字符串 / 必需

要创建的授权范围的名称。

realm

字符串 / 必需

Keycloak 客户端所在的 Keycloak 领域的名称。

state

字符串

授权范围的状态。

在 present 上，将创建授权范围（如果已存在，则更新）。

在 absent 上，如果授权范围存在，则将其删除。

选项

  • "present" ← (默认值)

  • "absent"

token

字符串

在 community.general 3.0.0 中添加

Keycloak API 的身份验证令牌。

validate_certs

布尔值

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

选项

  • false

  • true ← (默认值)

属性

属性

支持

描述

check_mode

支持： 完全

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

diff_mode

支持： 完全

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

示例

- name: Manage Keycloak file:delete authorization scope
  keycloak_authz_authorization_scope:
    name: file:delete
    state: present
    display_name: File delete
    client_id: myclient
    realm: myrealm
    auth_keycloak_url: https://127.0.0.1:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master

返回值

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

键

描述

end_state

复杂

模块执行后授权范围的表示形式。

返回：成功时

display_name

字符串

授权范围的显示名称。

返回：当 state=present 时

示例： "文件 删除"

icon_uri

字符串

授权范围的图标 URI。

返回：当 state=present 时

示例: "https://127.0.0.1/icon.png"

id

字符串

授权范围的 ID。

返回：当 state=present 时

示例: "a6ab1cf2-1001-40ec-9f39-48f23b6a0a41"

name

字符串

授权范围的名称。

返回：当 state=present 时

示例: "file:delete"

msg

字符串

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

返回: 总是

作者

  • Samuli Seppänen (@mattock)