Spire 天擎

外观

class AuthorizationCode ​

cangjie
public class AuthorizationCode <: Serializable<AuthorizationCode>

功能：表示授权码授权流程中的授权码数据。

父类型：

成员概览 ​

成员功能
var clientId保存授权码所属的客户端标识。
var lifetime保存授权码的有效时长。
var requestedScopes保存授权码关联的请求作用域列表。
var subject保存授权码关联的用户主体。
var creationTime保存授权码的创建时间。
var redirectUri保存授权请求使用的重定向地址。
var codeChallenge保存 PKCE 代码挑战值。
var codeChallengeMethod保存 PKCE 代码挑战方法。
var nonce保存授权请求关联的 nonce 值。
var sessionId保存授权码关联的会话标识。
func serialize()将当前授权码序列化为数据模型。
func deserialize(DataModel)从数据模型反序列化授权码。

var clientId ​

cangjie
public var clientId = String.empty

功能：保存授权码所属的客户端标识。

var lifetime ​

cangjie
public var lifetime = 0

功能：保存授权码的有效时长。

var requestedScopes ​

cangjie
public var requestedScopes: Array<String> = []

功能：保存授权码关联的请求作用域列表。

类型：Array<String>

var subject ​

cangjie
public var subject: ClaimsPrincipal = ClaimsPrincipal()

功能：保存授权码关联的用户主体。

类型：ClaimsPrincipal

var creationTime ​

cangjie
public var creationTime = DateTime.now().inUTC()

功能：保存授权码的创建时间。

var redirectUri ​

cangjie
public var redirectUri = String.empty

功能：保存授权请求使用的重定向地址。

var codeChallenge ​

cangjie
public var codeChallenge: ?String = None

功能：保存 PKCE 代码挑战值。

类型：?String

var codeChallengeMethod ​

cangjie
public var codeChallengeMethod: ?String = None

功能：保存 PKCE 代码挑战方法。

类型：?String

var nonce ​

cangjie
public var nonce: ?String = None

功能：保存授权请求关联的 nonce 值。

类型：?String

var sessionId ​

cangjie
public var sessionId: ?String = None

功能：保存授权码关联的会话标识。

类型：?String

func serialize() ​

cangjie
public func serialize(): DataModelStruct

功能：将当前授权码序列化为数据模型。

返回值：

  • DataModelStruct - 返回授权码对应的数据模型结构。

func deserialize(DataModel) ​

cangjie
public static func deserialize(dm: DataModel): AuthorizationCode

功能：从数据模型反序列化授权码。

参数：

  • dm: DataModel - 授权码对应的数据模型。

返回值：

异常：

  • InvalidDataException - 当数据模型不是结构类型时抛出。