JwtBearerOptions 类
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
选项类提供控制持有者身份验证中间件行为所需的信息
public ref class JwtBearerOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions
public class JwtBearerOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions
type JwtBearerOptions = class
inherit AuthenticationOptions
Public Class JwtBearerOptions
Inherits AuthenticationOptions
- 继承
构造函数
JwtBearerOptions() |
使用默认值创建持有者身份验证选项的实例。 |
属性
Audience |
获取或设置接收的任何 OpenIdConnect 令牌的受众。 |
AuthenticationScheme |
选项中的 AuthenticationScheme 对应于特定身份验证方案的逻辑名称。 可以分配其他值,以便在一个管道中多次使用同一个身份验证中间件类型。 (继承自 AuthenticationOptions) |
Authority |
获取或设置在执行 OpenIdConnect 调用时使用的 Authority。 |
AutomaticAuthenticate |
如果为 true,则身份验证中间件会更改传入的请求用户。 如果为 false,则身份验证中间件仅在 AuthenticationScheme 显式指示时才提供标识。 (继承自 AuthenticationOptions) |
AutomaticChallenge |
如果为 true,则身份验证中间件应处理自动质询。 如果为 false,则身份验证中间件仅在 AuthenticationScheme 显式指示时更改响应。 (继承自 AuthenticationOptions) |
BackchannelHttpHandler |
用于检索元数据的 HttpMessageHandler。 除非值为 WebRequestHandler,否则不能在设置 BackchannelCertificateValidator 的同时设置此项。 |
BackchannelTimeout |
获取或设置使用反向通道执行 http 调用时的超时。 |
Challenge |
获取或设置要放入“WWW-Authenticate”标头中的质询。 |
ClaimsIssuer |
获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationOptions) |
Configuration |
开发人员直接提供的配置。 如果未提供此项,则不使用 MetadataAddress 和 Backchannel 属性。 处理请求期间不应更新此信息。 |
ConfigurationManager |
负责检索、缓存和刷新元数据中的配置。 如果未提供此项,则会使用 MetadataAddress 和 Backchannel 属性创建一个。 |
Description |
为应用程序提供的有关身份验证类型的附加信息。 (继承自 AuthenticationOptions) |
Events |
应用程序提供的对象,用于处理持有者身份验证中间件引发的事件。 应用程序可以完全实现 接口,也可以创建 JwtBearerAuthenticationEvents 的实例,并将委托仅分配给它想要处理的事件。 |
IncludeErrorDetails |
定义是否应将令牌验证错误返回到调用方。 默认情况下,可以禁用此选项,以防止 JWT 中间件在 WWW-Authenticate 标头中返回错误和error_description。 |
MetadataAddress |
获取或设置用于获取元数据的发现终结点 |
RefreshOnIssuerKeyNotFound |
获取或设置在发生 SecurityTokenSignatureKeyNotFoundException 后是否应尝试刷新元数据。 如果是,则在发生签名密钥滚动更新的情况下可以执行自动发现。 此项已默认启用。 |
RequireHttpsMetadata |
获取或设置元数据地址或颁发机构是否需要 HTTPS。 默认值为 true。 应仅在开发环境中禁用此功能。 |
SaveToken |
定义在成功授权后是否应将持有者令牌存储在 中 AuthenticationProperties 。 |
SecurityTokenValidators |
获取用于验证访问令牌的 ISecurityTokenValidator 排序列表。 |
SystemClock |
仅用于测试目的。 |
SystemClock |
仅用于测试目的。 (继承自 AuthenticationOptions) |
TokenValidationParameters |
获取或设置用于验证标识令牌的参数。 |