Spire 天擎

外观

class JwtBearerOptions ​

cangjie
public class JwtBearerOptions <: AuthenticationSchemeOptions

功能：表示 JWT Bearer 身份验证方案的配置选项。

父类型：

成员概览 ​

成员功能
init()创建一组默认的 JWT Bearer 身份验证选项。
var saveToken指示是否在身份验证属性中保存访问令牌。
var authority获取或修改 OpenID Connect 颁发机构地址。
var metadataAddress获取或修改元数据终结点地址。
var requireHttpsMetadata指示获取元数据时是否必须使用 HTTPS。
var includeErrorDetails指示质询响应中是否包含详细错误信息。
let events获取 JWT Bearer 事件处理器集合。
var backchannel获取或修改用于后端通信的 HTTP 客户端。
var backchannelTimeout获取或修改后端 HTTP 请求的超时时间。
var backchannelHttpHandler获取或修改后端通信使用的 HTTP 消息处理器。
var challenge获取或修改质询响应使用的认证方案名称。
var configuration获取或修改固定使用的 OpenID Connect 配置。
var refreshInterval获取或修改配置刷新的最小间隔。
var automaticRefreshInterval获取或修改自动刷新配置的间隔。
var refreshOnIssuerKeyNotFound指示在签名密钥缺失时是否触发配置刷新。
var configurationManager获取或修改 OpenID Connect 配置管理器。
var tokenValidationParameters获取或修改令牌验证参数。
var securityTokenValidators获取或修改可用的安全令牌验证器列表。

init() ​

cangjie
public init()

功能：创建一组默认的 JWT Bearer 身份验证选项。

var saveToken ​

cangjie
public var saveToken = true

功能：指示是否在身份验证属性中保存访问令牌。

var authority ​

cangjie
public var authority = String.empty

功能：获取或修改 OpenID Connect 颁发机构地址。

var metadataAddress ​

cangjie
public var metadataAddress = String.empty

功能：获取或修改元数据终结点地址。

var requireHttpsMetadata ​

cangjie
public var requireHttpsMetadata = true

功能：指示获取元数据时是否必须使用 HTTPS。

var includeErrorDetails ​

cangjie
public var includeErrorDetails = true

功能：指示质询响应中是否包含详细错误信息。

let events ​

cangjie
public let events = JwtBearerEvents()

功能：获取 JWT Bearer 事件处理器集合。

var backchannel ​

cangjie
public var backchannel: ?HttpClient = None

功能：获取或修改用于后端通信的 HTTP 客户端。

类型：?HttpClient

var backchannelTimeout ​

cangjie
public var backchannelTimeout = Duration.minute * 1

功能：获取或修改后端 HTTP 请求的超时时间。

var backchannelHttpHandler ​

cangjie
public var backchannelHttpHandler: ?HttpMessageHandler = None

功能：获取或修改后端通信使用的 HTTP 消息处理器。

类型：?HttpMessageHandler

var challenge ​

cangjie
public var challenge = JwtBearerDefaults.Scheme

功能：获取或修改质询响应使用的认证方案名称。

var configuration ​

cangjie
public var configuration: ?OpenIdConnectConfiguration = None

功能：获取或修改固定使用的 OpenID Connect 配置。

类型：?OpenIdConnectConfiguration

var refreshInterval ​

cangjie
public var refreshInterval: Duration

功能：获取或修改配置刷新的最小间隔。

类型：Duration

var automaticRefreshInterval ​

cangjie
public var automaticRefreshInterval: Duration

功能：获取或修改自动刷新配置的间隔。

类型：Duration

var refreshOnIssuerKeyNotFound ​

cangjie
public var refreshOnIssuerKeyNotFound = true

功能：指示在签名密钥缺失时是否触发配置刷新。

var configurationManager ​

cangjie
public var configurationManager: ?IConfigurationManager<OpenIdConnectConfiguration> = None

功能：获取或修改 OpenID Connect 配置管理器。

类型：?IConfigurationManager<OpenIdConnectConfiguration>

var tokenValidationParameters ​

cangjie
public var tokenValidationParameters = TokenValidationParameters()

功能：获取或修改令牌验证参数。

var securityTokenValidators ​

cangjie
public var securityTokenValidators: List<ISecurityTokenValidator>

功能：获取或修改可用的安全令牌验证器列表。

类型：List<ISecurityTokenValidator>