JwtBearerOptions 类

定义

命名空间:

Microsoft.AspNetCore.Authentication.JwtBearer

程序集:

Microsoft.AspNetCore.Authentication.JwtBearer.dll

包:

Microsoft.AspNetCore.Authentication.JwtBearer v9.0.0

Source:

JwtBearerOptions.cs

Options 类提供控制持有者身份验证处理程序行为所需的信息

public ref class JwtBearerOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class JwtBearerOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type JwtBearerOptions = class
    inherit AuthenticationSchemeOptions

Public Class JwtBearerOptions
Inherits AuthenticationSchemeOptions

继承

Object

AuthenticationSchemeOptions

JwtBearerOptions

构造函数

JwtBearerOptions()

初始化 JwtBearerOptions 的新实例。

属性

Audience	获取或设置任何收到的 OpenIdConnect 令牌的单个有效受众值。 如果此属性为空，此值将传递到 TokenValidationParameters.ValidAudience 中。
Authority	获取或设置在执行 OpenIdConnect 调用时使用的 Authority。
AutomaticRefreshInterval	获取或设置自动元数据刷新的频率。
Backchannel	用于检索元数据的反向通道。
BackchannelHttpHandler	用于检索元数据的 HttpMessageHandler。 除非值为 WebRequestHandler，否则不能在设置 BackchannelCertificateValidator 的同时设置此项。
BackchannelTimeout	获取或设置使用反向通道执行 http 调用时的超时。
Challenge	获取或设置要放入“WWW-Authenticate”标头中的质询。
ClaimsIssuer	获取或设置应用于创建的任何声明的颁发者 (继承自 AuthenticationSchemeOptions)
Configuration	开发人员直接提供的配置。 如果未提供此项，则不使用 MetadataAddress 和 Backchannel 属性。 处理请求期间不应更新此信息。
ConfigurationManager	负责检索、缓存和刷新元数据中的配置。 如果未提供此项，则会使用 MetadataAddress 和 Backchannel 属性创建一个。
Events	应用程序提供的对象，用于处理由持有者身份验证处理程序引发的事件。 应用程序可以完全实现 接口，也可以创建 JwtBearerEvents 实例，并将委托仅分配给它想要处理的事件。
EventsType	如果设置， 将用作服务类型来获取事件实例而不是 属性。 (继承自 AuthenticationSchemeOptions)
ForwardAuthenticate	如果设置，则指定此方案应将 AuthenticateAsync 调用转发到的目标方案。 例如 Context.AuthenticateAsync (“ThisScheme”) => Context.AuthenticateAsync (“ForwardAuthenticateValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardChallenge	如果已设置，则指定此方案应将 ChallengeAsync 调用转发到的目标方案。 例如 Context.ChallengeAsync (“ThisScheme”) => Context.ChallengeAsync (“ForwardChallengeValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardDefault	如果设置，这将指定默认方案，身份验证处理程序应默认将所有身份验证操作转发到该方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，然后检查 ForwardDefault。 第一个非 null 结果将用作要转发的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardDefaultSelector	用于为身份验证处理程序默认将所有身份验证操作转发到的当前请求选择默认方案。 默认转发逻辑将首先检查最具体的 ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 设置，然后检查 ForwardDefaultSelector，然后检查 ForwardDefault。 第一个非 null 结果将用作要转发的目标方案。 (继承自 AuthenticationSchemeOptions)
ForwardForbid	如果已设置，则指定此方案应将 ForbidAsync 调用转发到的目标方案。 例如 Context.ForbidAsync (“ThisScheme”) => Context.ForbidAsync (“ForwardForbidValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignIn	如果设置，则指定此方案应将 SignInAsync 调用转发到的目标方案。 例如 Context.SignInAsync (“ThisScheme”) => Context.SignInAsync (“ForwardSignInValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
ForwardSignOut	如果设置，则指定此方案应将 SignOutAsync 调用转发到的目标方案。 例如 Context.SignOutAsync (“ThisScheme”) => Context.SignOutAsync (“ForwardSignOutValue”) ;将目标设置为当前方案以禁用转发并允许正常处理。 (继承自 AuthenticationSchemeOptions)
IncludeErrorDetails	定义是否应将令牌验证错误返回给调用方。 默认情况下，可以禁用此选项，以防止 JWT 处理程序在 WWW-Authenticate 标头中返回错误和error_description。
MapInboundClaims	获取或设置 MapInboundClaims SecurityTokenValidators 中或 JsonWebTokenHandler TokenHandlers 中默认实例JwtSecurityTokenHandler上的 属性，在确定是否映射验证 JwtSecurityToken 或 JsonWebToken时提取的声明类型。 如果设置为 true，则使用此映射转换后，“声明类型”将设置为 JSON 声明“name”。 否则，不会发生映射。 默认值为 true。
MetadataAddress	获取或设置用于获取元数据的发现终结点
RefreshInterval	获取或设置检索之间的最短时间（如果检索失败或显式请求刷新）。
RefreshOnIssuerKeyNotFound	获取或设置在发生 SecurityTokenSignatureKeyNotFoundException 后是否应尝试刷新元数据。 如果是，则在发生签名密钥滚动更新的情况下可以执行自动发现。 此项已默认启用。
RequireHttpsMetadata	获取或设置元数据地址或颁发机构是否需要 HTTPS。 默认值为 true。 这只能在开发环境中禁用。
SaveToken	定义在成功授权后是否应将持有者令牌存储在 中 AuthenticationProperties 。
SecurityTokenValidators	已过时. 获取用于验证访问令牌的 ISecurityTokenValidator 的有序列表。
TimeProvider	用于测试。 (继承自 AuthenticationSchemeOptions)
TokenHandlers	获取用于验证访问令牌的 TokenHandler 的有序列表。
TokenValidationParameters	获取或设置用于验证标识令牌的参数。
UseSecurityTokenValidators	获取或设置是否 TokenHandlers 使用 或 SecurityTokenValidators 来验证入站令牌。

方法

Validate()	检查选项是否有效。 如果情况不正常，应引发异常。 (继承自 AuthenticationSchemeOptions)
Validate(String)	检查选项是否对特定方案有效 (继承自 AuthenticationSchemeOptions)