Authz Keycloak 配置选项
Authz Keycloak 插件将 APISIX 和 API7 网关请求的 UMA 权限决策委托给 Keycloak 授权服务。 配置涵盖插件参数。
参数
请参阅 插件通用配置 了解所有插件可用的配置选项。
该插件支持在字符串类型的配置字段中使用网关引用。使用 $env:// 前缀引用环境变量中的值,或使用 $secret:// 前缀引用密钥管理器中的值,例如 HashiCorp Vault 的 KV 密钥引擎。网关在运行时解析这些引用。ADC 的 ${NAME} 插值有所不同:ADC 在同步前加载配置文件时解析插值。有关更多信息,请参阅插件中的环境变量和密钥。
client_id
Client ID。
client_secret
插件向 Token 端点进行身份认证时使用的 Client Secret。启用字段加密且配置存储在 etcd 中时,网关会先加密此值再存储。
discovery
发现文档的 URL。
discovery和token_endpoint至少需要配置一个。token_endpoint
支持
urn:ietf:params:oauth:grant-type:uma-ticket授权类型并用于权限评估的 Token 端点。如果提供此项,它将覆盖发现文档中的值。discovery和token_endpoint至少需要配置一个。resource_registration_endpoint
符合 UMA 标准的资源注册端点。当
lazy_load_paths为true时,插件优先使用此值,否则从发现文档获取该端点。动态路径加载需要配置discovery,或同时配置token_endpoint和resource_registration_endpoint。grant_type
有效值:
urn:ietf:params:oauth:grant-type:uma-ticket用于权限评估的 UMA Ticket 授权类型。这是默认值,也是唯一可接受的值。
policy_enforcement_mode
有效值:
ENFORCING或PERMISSIVE控制插件在向 Keycloak 请求决策之前如何处理空权限列表。
在
ENFORCING模式下,空权限列表会返回403 Forbidden;如果配置了access_denied_redirect_uri,则返回307 Temporary Redirect。在
PERMISSIVE模式下,插件继续发送不含 permission 参数的 UMA Token 请求,最终仍由 Keycloak 决定是否授权。permissions
表示客户端要访问的资源和 Scope 的权限。支持
RESOURCE_ID#SCOPE_ID、RESOURCE_ID和#SCOPE_ID三种格式。同一资源的多个 Scope 用逗号分隔,例如RESOURCE_ID#SCOPE_1,SCOPE_2。当lazy_load_paths为false时使用。参见获取权限。Keycloak 必须授予配置的每个权限及每个权限中的所有 Scope。Scope 名称前后的空格会被忽略。APISIX 3.20.0、API7 Enterprise 3.9.23 和 3.10.9 实施此要求。更早的版本只要请求的权限中有任意一个被授予就会转发请求。
lazy_load_paths