community.general.keycloak_realm_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_info。

community.general 4.3.0 中的新增功能

概要

  • 此模块允许您通过 Keycloak REST API 获取 Keycloak 领域的公共信息。

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

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

参数

参数

注释

auth_keycloak_url

别名：url

字符串 / 必需

Keycloak 实例的 URL。

realm

字符串

Keycloak 领域的 ID。

默认值： "master"

validate_certs

布尔值

验证 TLS 证书（不要在生产环境中禁用此选项）。

选项

  • false

  • true ← (默认)

属性

属性

支持

描述

check_mode

支持：完全支持

此操作不会修改状态。

可以在 check_mode 中运行，并在不修改目标的情况下返回更改状态预测。

diff_mode

支持： N/A

此操作不会修改状态。

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

示例

- name: Get a Keycloak public key
  community.general.keycloak_realm_info:
    realm: MyCustomRealm
    auth_keycloak_url: https://auth.example.com/auth
  delegate_to: localhost

返回值

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

键

描述

msg

字符串

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

返回：始终

realm_info

字典

领域公共信息的表示。

返回：始终

account-service

字符串

帐户控制台 URL。

返回：始终

示例： "https://auth.example.com/auth/realms/MyRealm/account"

public_key

字符串

领域的公钥。

返回：始终

示例： "MIIBIjANBgkqhkiG9w0BAQEFAAO..."

realm

字符串

Realm ID。

返回：始终

示例： "MyRealm"

token-service

字符串

令牌端点 URL。

返回：始终

示例： "https://auth.example.com/auth/realms/MyRealm/protocol/openid-connect"

tokens-not-before

整数

令牌生效时间之前的秒数。

返回：始终

示例： 0

作者

  • 陈芬 (@fynncfchen)