Keycloak 协议映射器配置选项的所有记录在哪里?

Where are all of the Keycloak Protocol Mapper Config Options documented?

我正在使用 Keycloak 的 Java keycloak-admin-client,我想为我的领域的客户端设置一些协议映射器。

Java API 公开此 class 以创建协议映射器,然后使用以下方法设置配置选项:

    ProtocolMapperRepresentation protocolMapperRep = new ProtocolMapperRepresentation();
    protocolMapperRep.setConfig(Map.of("some.mapper.config.option", "mapper-value"));

我查看了 javadoc 文档,不幸的是,它完全没用。 :( 我没有看过 rest-api 文档,但我只是看过它,它没有做任何事情来枚举协议映射器表示的配置选项:https://www.keycloak.org/docs-api/12.0/rest-api/index.html#_protocolmapperrepresentation

我在这里看到了另一个 Whosebug 问题的一些选项:

但是,必须 是记录这些内容的更好的地方。

通常,您可以先查看 Rest API Documentation and the Keycloak API

或者,这 几乎 总是有效,您只需使用 Keycloak Admin API 创建协议映射器,例如:

然后在点击 Save 之前,打开您的浏览器开发者网络控制台并查看网络请求。然后点击save:

您将有两个 post 请求,一个用于令牌,另一个用于创建映射器:

查看请求负载,您会看到如下内容:

{"protocol":"openid-connect","config {"multivalued":"true","id.token.claim":"true","access.token.claim":"true","userinfo.token.claim":"true","claim.name":"asdas"},"name":"asdas","protocolMapper":"oidc-usermodel-realm-role-mapper"}

现在您可以从那里推断出选项。我知道不理想。

Keycloak 15 的列表如下(仅缺少成对主题标识符):

  • oidc-usersessionmodel-note-mapper
  • oidc-group-membership-mapper
  • oidc-usermodel-attribute-mapper
  • oidc-usermodel-realm-role-mapper
  • oidc-受众映射器
  • oidc-usermodel-属性-mapper
  • oidc-hardcoded-claim-mapper
  • oidc-硬编码角色映射器
  • oidc-allowed-origins-mapper
  • oidc-audience-resolve-mapper
  • oidc-claims-param-token-mapper
  • oidc-usermodel-client-role-mapper
  • oidc-full-name-mapper
  • oidc-地址映射器
  • oidc-角色名称映射器