JWTBearerOAuth2AccessTokenProvider¶
描述¶
提供 OAuth 2.0 访问令牌,可用作 HTTP 请求中的 Bearer 授权标头。此控制器服务用于实现 OAuth 2.0 JWT Bearer 流。
属性¶
下表列出了各项属性,其中带星号 (*) 的为必需属性。其他属性视为可选属性。该表还指出了所有默认值以及属性是否支持 NiFi 表达式语言。
显示名称 |
API 名称 |
默认值 |
允许值 |
描述 |
---|---|---|---|---|
断言参数名称 * |
断言参数名称 |
断言 |
在对令牌端点的请求中用于 JWT 断言的参数的名称。 |
|
受众 |
受众 |
JWT 中的受众声明 (aud)。如果预计有多个接收方,则使用空格分隔的受众列表。 |
||
授权类型 * |
授权类型 |
在向令牌端点发出的请求中为 grant_type 参数设置的值。 |
||
签发方 |
签发方 |
JWT 中的签发方声明 (iss)。 |
||
JWT 过期时间 * |
JWT 过期时间 |
1 小时 |
用于设置相应的 JWT 声明的过期时间。如果返回的访问令牌不包括过期时间,则将在刷新窗口中使用该令牌来重新获取新的访问令牌。 |
|
JWT ID |
JWT ID |
“jti” (JWT ID) 声明为 JWT 提供唯一标识符。该标识符的赋值方式必须确保不同数据对象意外获得相同值的概率极低;如果应用程序使用多个签发方,还 MUST 防止不同签发方生成的值之间发生冲突。“jti”值是一个区分大小写的字符串。如果已设置,建议将此值设置为 ${UUID()}。 |
||
密钥 ID |
密钥 ID |
用于签署 JWT 的公钥的 ID。它将用作 JWT 中的 kid 标头。 |
||
私钥服务 * |
私钥服务 |
用于签署 JWTs 的私钥服务。 |
||
刷新窗口 * |
刷新窗口 |
5 分钟 |
该服务将尝试刷新在刷新窗口内即将到期的令牌,并从令牌到期时间中减去配置的持续时间。 |
|
SSL Context Service * |
SSL Context Service |
配置了证书的 SSLContextProvider 实例,用于设置 x5t 标头。必须使用 RSA 算法。 |
||
范围 |
范围 |
JWT 的范围声明(范围)。 |
||
设置 JWT 标头 X.509 证书指纹 * |
设置 JWT 标头 X.509 证书指纹 |
false |
|
如果为 true,则会将 JWT 标头的 x5t 字段设置为使用 X.509 证书的 DER 编码的 SHA-256 指纹(并使用 base64url 编码)。如果设置为 true,必须配置一个采用 RSA 算法证书的 SSLContextProvider 实例。 |
签名算法 * |
签名算法 |
PS256 |
|
用于签署 JWT 的算法。 |
主题 |
主题 |
JWT 的主题声明 (sub)。 |
||
令牌端点 URL * |
令牌端点 URL |
OAuth2 令牌端点的 URL。 |
||
Web 客户端服务 * |
Web 客户端服务 |
用于调用令牌端点的 Web 客户端服务。 |
状态管理¶
此组件不存储状态。
受限¶
此组件不受限制。
系统资源注意事项¶
此组件未指定系统资源注意事项。