Spire 天擎

外观

interface AuthenticationHttpContextExtensions ​

cangjie
public interface AuthenticationHttpContextExtensions

功能：定义 HttpContext 的身份验证扩展操作。

扩展到 ​

成员概览 ​

成员功能
func authenticate()使用默认方案执行身份验证。
func authenticate(?String)使用指定方案执行身份验证。
func challenge()使用默认方案发起质询。
func challenge(?String)使用指定方案发起质询。
func challenge(?AuthenticationProperties)使用默认方案和指定属性发起质询。
func challenge(?String, ?AuthenticationProperties)使用指定方案和属性发起质询。
func forbid()使用默认方案执行禁止访问处理。
func forbid(?String)使用指定方案执行禁止访问处理。
func forbid(?AuthenticationProperties)使用默认方案和指定属性执行禁止访问处理。
func forbid(?String, ?AuthenticationProperties)使用指定方案和属性执行禁止访问处理。
func signIn(?String, ClaimsPrincipal)使用指定方案登录用户。
func signIn(ClaimsPrincipal)使用默认方案登录用户。
func signIn(ClaimsPrincipal, ?AuthenticationProperties)使用默认方案和属性登录用户。
func signIn(?String, ClaimsPrincipal, ?AuthenticationProperties)使用指定方案和属性登录用户。
func signOut()使用默认方案执行登出。
func signOut(?AuthenticationProperties)使用默认方案和属性执行登出。
func signOut(?String)使用指定方案执行登出。
func signOut(?String, ?AuthenticationProperties)使用指定方案和属性执行登出。
func getToken(String)从默认方案获取令牌值。
func getToken(String, String)从指定方案获取令牌值。

func authenticate() ​

cangjie
func authenticate(): AuthenticateResult

功能：使用默认方案执行身份验证。

返回值：

func authenticate(?String) ​

cangjie
func authenticate(scheme: ?String): AuthenticateResult

功能：使用指定方案执行身份验证。

参数：

  • scheme: ?String - 身份验证方案名称。

返回值：

func challenge() ​

cangjie
func challenge(): Unit

功能：使用默认方案发起质询。

返回值：

  • Unit

func challenge(?String) ​

cangjie
func challenge(scheme: ?String): Unit

功能：使用指定方案发起质询。

参数：

  • scheme: ?String - 身份验证方案名称。

返回值：

  • Unit

func challenge(?AuthenticationProperties) ​

cangjie
func challenge(properties: ?AuthenticationProperties): Unit

功能：使用默认方案和指定属性发起质询。

参数：

返回值：

  • Unit

func challenge(?String, ?AuthenticationProperties) ​

cangjie
func challenge(scheme: ?String, properties: ?AuthenticationProperties): Unit

功能：使用指定方案和属性发起质询。

参数：

返回值：

  • Unit

func forbid() ​

cangjie
func forbid(): Unit

功能：使用默认方案执行禁止访问处理。

返回值：

  • Unit

func forbid(?String) ​

cangjie
func forbid(scheme: ?String): Unit

功能：使用指定方案执行禁止访问处理。

参数：

  • scheme: ?String - 身份验证方案名称。

返回值：

  • Unit

func forbid(?AuthenticationProperties) ​

cangjie
func forbid(properties: ?AuthenticationProperties): Unit

功能：使用默认方案和指定属性执行禁止访问处理。

参数：

返回值：

  • Unit

func forbid(?String, ?AuthenticationProperties) ​

cangjie
func forbid(scheme: ?String, properties: ?AuthenticationProperties): Unit

功能：使用指定方案和属性执行禁止访问处理。

参数：

返回值：

  • Unit

func signIn(?String, ClaimsPrincipal) ​

cangjie
func signIn(scheme: ?String, principal: ClaimsPrincipal): Unit

功能：使用指定方案登录用户。

参数：

  • scheme: ?String - 身份验证方案名称。
  • principal: ClaimsPrincipal - 待登录的用户主体。

返回值：

  • Unit

func signIn(ClaimsPrincipal) ​

cangjie
func signIn(principal: ClaimsPrincipal): Unit

功能：使用默认方案登录用户。

参数：

返回值：

  • Unit

func signIn(ClaimsPrincipal, ?AuthenticationProperties) ​

cangjie
func signIn(principal: ClaimsPrincipal, properties: ?AuthenticationProperties): Unit

功能：使用默认方案和属性登录用户。

参数：

返回值：

  • Unit

func signIn(?String, ClaimsPrincipal, ?AuthenticationProperties) ​

cangjie
func signIn(scheme: ?String, principal: ClaimsPrincipal, properties: ?AuthenticationProperties): Unit

功能：使用指定方案和属性登录用户。

参数：

返回值：

  • Unit

func signOut() ​

cangjie
func signOut(): Unit

功能：使用默认方案执行登出。

返回值：

  • Unit

func signOut(?AuthenticationProperties) ​

cangjie
func signOut(properties: ?AuthenticationProperties): Unit

功能：使用默认方案和属性执行登出。

参数：

返回值：

  • Unit

func signOut(?String) ​

cangjie
func signOut(scheme: ?String): Unit

功能：使用指定方案执行登出。

参数：

  • scheme: ?String - 身份验证方案名称。

返回值：

  • Unit

func signOut(?String, ?AuthenticationProperties) ​

cangjie
func signOut(scheme: ?String, properties: ?AuthenticationProperties): Unit

功能：使用指定方案和属性执行登出。

参数：

返回值：

  • Unit

func getToken(String) ​

cangjie
func getToken(tokenName: String): ?String

功能：从默认方案获取令牌值。

参数：

  • tokenName: String - 令牌名称。

返回值：

  • ?String - 令牌值；不存在时返回 None。

func getToken(String, String) ​

cangjie
func getToken(scheme: String, tokenName: String): ?String

功能：从指定方案获取令牌值。

参数：

  • scheme: String - 身份验证方案名称。
  • tokenName: String - 令牌名称。

返回值：

  • ?String - 令牌值；不存在时返回 None。