community.general.keycloak_authz_permission_info 模块 – 查询 Keycloak 客户端授权权限信息

注意

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

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

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

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

community.general 7.2.0 中的新增功能

概要 

此模块允许通过 Keycloak REST API 的资源端点查询有关 Keycloak 客户端授权权限的信息。只有在客户端启用授权的情况下，授权权限才可用。
此模块需要通过 OpenID Connect 访问 REST API；连接的用户和使用的 Realm 必须具有必要的访问权限。在默认的 Keycloak 安装中，admin-cli 和管理员用户都可以工作，单独的 Realm 定义（其范围根据您的需求定制）和具有预期角色的用户也可以工作。
模块选项的名称是 Keycloak 使用的 camelCase 选项的 snake_case 版本。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 Realm 名称。
auth_username 别名：username 字符串	用于 API 访问身份验证的用户名。
client_id 字符串 / 必填	应该具有授权范围的 Keycloak 客户端的 clientId。这通常是 Keycloak 客户端的可读名称。
connection_timeout 整数 community.general 4.5.0 中新增	控制对 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。默认值： `10`
http_agent 字符串 community.general 5.4.0 中新增	配置 HTTP User-Agent 标头。默认值： `"Ansible"`
name 字符串 / 必填	要创建的授权权限的名称。
realm 字符串 / 必填	Keycloak 客户端所在的 Keycloak Realm 的名称。
token 字符串 community.general 3.0.0 中新增	Keycloak API 的身份验证令牌。
validate_certs 布尔值	验证 TLS 证书（在生产环境中不要禁用此选项）。选项 `false` `true` ← (默认)

属性 

属性	支持	描述
check_mode	支持：完全支持此操作不会修改状态。	可以在 `check_mode` 中运行，并在不修改目标的情况下返回更改状态预测。
diff_mode	支持： N/A 此操作不会修改状态。	在差异模式下，将返回有关更改内容（或可能需要在`check_mode`中更改的内容）的详细信息。

示例 

- name: Query Keycloak authorization permission
  community.general.keycloak_authz_permission_info:
    name: ScopePermission
    client_id: myclient
    realm: myrealm
    auth_keycloak_url: https://:8080/auth
    auth_username: keycloak
    auth_password: keycloak
    auth_realm: master

返回值 

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

键	描述
msg 字符串	关于采取了什么操作的消息。返回值：始终返回
queried_state 复杂类型	Keycloak看到的资源（策略）状态。返回值：成功时返回
config 字典	权限的配置（在所有观察到的案例中为空）。返回值：成功时返回示例： `{}`
decisionStrategy 字符串	决策策略。返回值：成功时返回示例： `"UNANIMOUS"`
description 字符串	授权权限的描述。返回值：成功时返回示例： `"Resource Permission"`
id 字符串	授权权限的ID。返回值：成功时返回示例： `"9da05cd2-b273-4354-bbd8-0c133918a454"`
logic 字符串	用于权限的逻辑（有效负载的一部分，但具有固定值）。返回值：成功时返回示例： `"POSITIVE"`
name 字符串	授权权限的名称。返回值：成功时返回示例： `"ResourcePermission"`
type 字符串	授权权限的类型。返回值：成功时返回示例： `"resource"`

作者

Samuli Seppänen (@mattock)