第 5 章 使用客户端注册服务
为了让应用程序或服务使用红帽构建的 Keycloak,它必须在红帽构建的 Keycloak 中注册客户端。管理员可以通过管理控制台(或管理 REST 端点)执行此操作,但客户端还可以通过红帽构建的 Keycloak 客户端注册服务来注册。
客户端注册服务为红帽构建的 Keycloak Client Representations、OpenID Connect Client Meta Data 和 SAML Entity Descriptors 提供内置的支持。客户端注册服务端点为 /realms/<realm>/clients-registrations/<provider>
;。
内置支持的 供应商
有:
- 默认 - 红帽构建的 Keycloak Client Representation (JSON)
- install - 红帽构建的 Keycloak Adapter 配置(JSON)
- openid-connect - OpenID Connect Client Metadata Description (JSON)
- saml2-entity-descriptor - SAML Entity Descriptor (XML)
以下小节介绍了如何使用不同的供应商。
5.1. 身份验证
若要调用您通常需要令牌的客户端注册服务。令牌可以是 bearer 令牌、初始访问令牌或注册访问令牌。另外,也可以注册新客户端而无需令牌,但需要配置客户端注册策略(请参阅以下)。
5.1.1. bearer 令牌
bearer 令牌可以代表用户或服务帐户发布。调用端点需要以下权限( 更多详情请参阅 服务器管理指南 ):
- create-client 或 manage-client - 要创建客户端
- view-client 或 manage-client - 查看客户端
- manage-client - 要更新或删除客户端
如果您使用 bearer 令牌创建客户端,建议只使用 create-client
角色的服务帐户中的令牌(更多详情请参阅 服务器管理指南 )。
5.1.2. 初始访问令牌
注册新客户端的建议方法是使用初始访问令牌。初始访问令牌只能用于创建客户端,并具有可配置的过期时间,以及可创建客户端数量的可配置限制。
可以通过管理控制台创建初始访问令牌。若要创建新的初始访问令牌,首先在 admin 控制台中选择域,然后单击左侧菜单中的 Client
,然后在页面中显示的选项卡中显示 Initial access token
。
现在,您可以看到任何现有的初始访问令牌。如果您有访问权限,可以删除不再需要的令牌。您只能在创建令牌时检索令牌的值。要创建新令牌,请点 Create
。现在,您可以选择添加令牌应有效的时长,也可以使用令牌创建客户端数量。点击 Save
the token 值后会显示。
现在,您复制/粘贴此令牌非常重要,因为您现在无法在以后检索它。如果您忘记复制/粘贴它,请删除令牌并创建另一个令牌。
令牌值在调用客户端注册服务时用作标准 bearer 令牌,方法是将它添加到请求中的 Authorization 标头中。例如:
Authorization: bearer eyJhbGciOiJSUz...
5.1.3. 注册访问令牌
通过客户端注册服务创建客户端时,响应将包括注册访问令牌。通过注册访问令牌,可以稍后检索客户端配置,但也可用于更新或删除客户端。注册访问令牌包含在请求中,其方式与 bearer 令牌或初始访问令牌相同。
默认情况下启用注册访问令牌轮转。这意味着注册访问令牌只有效一次。使用令牌时,响应将包含新令牌。请注意,可以使用 客户端策略 禁用注册访问令牌 轮转。
如果在客户端注册服务之外创建了客户端,它不会关联有注册访问令牌。您可以通过 admin 控制台创建一个。如果您丢失了特定客户端的令牌,这也很有用。若要创建新令牌,可在管理控制台中找到客户端,然后单击 凭据
。然后单击 Generate registration access token
。