community.general.keycloak_realm_keys_metadata_info 模块 – 通过 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_realm_keys_metadata_info。

community.general 9.3.0 中的新增功能

概要 

此模块允许您通过 Keycloak REST API 获取 Keycloak 领域密钥元数据。
模块选项名称是 Keycloak API 及其文档中找到的 camelCase 名称的 snake_case 版本，文档位于 https://keycloak.java.net.cn/docs-api/latest/rest-api/index.html。

参数 

参数	注释
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 访问身份验证的用户名。
connection_timeout 整数 community.general 4.5.0 中新增	控制 Keycloak API 的 HTTP 连接超时时间（以秒为单位）。默认值： `10`
http_agent 字符串 community.general 5.4.0 中新增	配置 HTTP User-Agent 头。默认值： `"Ansible"`
realm 字符串	要获取密钥元数据的 Keycloak 领域。默认值： `"master"`
token 字符串 community.general 3.0.0 中新增	Keycloak API 的身份验证令牌。
validate_certs 布尔值	验证 TLS 证书（不要在生产环境中禁用此选项）。选项 `false` `true` ← (默认)

属性 

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

示例 

- name: Fetch Keys metadata
  community.general.keycloak_realm_keys_metadata_info:
    auth_keycloak_url: https://auth.example.com/auth
    auth_realm: master
    auth_username: USERNAME
    auth_password: PASSWORD
    realm: MyCustomRealm
  delegate_to: localhost
  register: keycloak_keys_metadata

- name: Write the Keycloak keys certificate into a file
  ansible.builtin.copy:
    dest: /tmp/keycloak.cert
    content: |
      {{ keys_metadata['keycloak_keys_metadata']['keys']
      | selectattr('algorithm', 'equalto', 'RS256')
      | map(attribute='certificate')
      | first
      }}
  delegate_to: localhost

返回值 

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

键	描述
keys_metadata 字典	领域密钥元数据的表示（请参阅 https://keycloak.java.net.cn/docs-api/latest/rest-api/index.html#KeysMetadataRepresentation）。返回值：始终返回
active 字典	密钥算法到 UUID 的映射（即字典）。返回值：始终返回
keys 列表 / 元素=字典	提供密钥详细信息的字典列表。返回值：始终返回
msg 字符串	关于执行了哪些操作的消息。返回值：始终返回

作者

Thomas Bach (@thomasbach-dev)