Spire 天擎

外观

class IdentityUser ​

cangjie
public class IdentityUser

功能：表示身份服务中的用户上下文信息。

成员概览 ​

成员功能
init(String)使用主体标识创建用户上下文。
let sub保存用户主体标识。
var amr保存认证方法引用值。
var idp保存身份提供方标识。
var sid保存会话标识。
var authTime保存用户认证时间。
prop claims返回当前用户的自定义声明列表。
func addClaim(String, String)添加一条自定义声明。
func toPrincipal()将当前用户上下文转换为声明主体。

init(String) ​

cangjie
public init(sub: String)

功能：使用主体标识创建用户上下文。

参数：

  • sub: String - 用户主体标识。

let sub ​

cangjie
public let sub: String

功能：保存用户主体标识。

类型：String

var amr ​

cangjie
public var amr: String = "pwd"

功能：保存认证方法引用值。

类型：String

var idp ​

cangjie
public var idp: String = "local"

功能：保存身份提供方标识。

类型：String

var sid ​

cangjie
public var sid: ?String = None

功能：保存会话标识。

类型：?String

var authTime ​

cangjie
public var authTime: DateTime = DateTime.now().inUTC()

功能：保存用户认证时间。

类型：DateTime

prop claims ​

cangjie
public prop claims: ReadOnlyList<Claim>

功能：返回当前用户的自定义声明列表。

类型：ReadOnlyList<Claim>

func addClaim(String, String) ​

cangjie
public func addClaim(`type`: String, value: String): Unit

功能：添加一条自定义声明。

参数：

  • type: String
  • value: String - 声明值。

返回值：

  • Unit

异常：

  • UnsupportedException - 当声明类型属于协议保留声明时抛出。

func toPrincipal() ​

cangjie
public func toPrincipal(): ClaimsPrincipal

功能：将当前用户上下文转换为声明主体。

返回值：

  • ClaimsPrincipal - 返回包含协议声明和自定义声明的主体对象。