community.general.keycloak_authentication_required_actions 模块 – 允许管理 Keycloak 身份验证所需的 action

注意

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

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

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

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

community.general 7.1.0 中的新增功能

概要 

此模块可以注册、更新和删除所需的 action。
它还会根据其别名过滤掉任何重复的必需 action。保留第一次出现的 action。

参数 

参数	注释
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 访问身份验证的用户名。
connection_timeout 整数 community.general 4.5.0 中新增	控制对 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。默认值： `10`
http_agent 字符串 community.general 5.4.0 中新增	配置 HTTP User-Agent 头。默认值： `"Ansible"`
realm 字符串 / 必需	包含身份验证所需 action 的 realm 的名称。
required_actions 列表 / 元素=字典	身份验证所需的 action。
alias 字符串 / 必需	所需 action 的唯一名称。
config 字典	所需 action 的配置。
defaultAction 布尔值	指示任何新用户是否将为此分配所需的 action。选项 `false` `true`
enabled 布尔值	指示所需的 action 是否启用。选项 `false` `true`
name 字符串	所需 action 的显示名称。注册时必需。
priority 整数	所需 action 的优先级。
providerId 字符串	所需 action 的提供程序 ID。注册时必需。
state 字符串 / 必需	控制是否要注册/更新 realm 身份验证所需的 action (`present`) 或删除 (`absent`)。选项 `"absent"` `"present"`
token 字符串 community.general 3.0.0 中新增	Keycloak API 的身份验证令牌。
validate_certs 布尔值	验证 TLS 证书（不要在生产环境中禁用此项）。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: Register a new required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "https://127.0.0.1:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_action:
      - alias: "TERMS_AND_CONDITIONS"
        name: "Terms and conditions"
        providerId: "TERMS_AND_CONDITIONS"
        enabled: true
    state: "present"

- name: Update the newly registered required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "https://127.0.0.1:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_action:
      - alias: "TERMS_AND_CONDITIONS"
        enabled: false
    state: "present"

- name: Delete the updated registered required action.
  community.general.keycloak_authentication_required_actions:
    auth_client_id: "admin-cli"
    auth_keycloak_url: "https://127.0.0.1:8080"
    auth_password: "password"
    auth_realm: "master"
    auth_username: "admin"
    realm: "master"
    required_action:
      - alias: "TERMS_AND_CONDITIONS"
    state: "absent"

返回值 

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

键	描述
end_state complex	表示模块执行后所需的认证操作。返回值：成功时
alias 字符串	所需 action 的唯一名称。返回值： success 示例： `"test-provider-id"`
config 字典	所需 action 的配置。返回值： success 示例： `{}`
defaultAction 布尔值	指示任何新用户是否将为此分配所需的 action。返回值： success 示例： `false`
enabled 布尔值	指示所需的 action 是否启用。返回值： success 示例： `false`
name 字符串	所需 action 的显示名称。注册时必需。返回值： success 示例： `"Test provider ID"`
priority 整数	所需 action 的优先级。返回值： success 示例： `90`
providerId 字符串	所需 action 的提供程序 ID。注册时必需。返回值： success 示例： `"test-provider-id"`
msg 字符串	关于已采取操作的消息。返回值：始终返回

作者

Skrekulko (@Skrekulko)