OpenIdConnectHandler 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.OpenIdConnect

組件:

Microsoft.AspNetCore.Authentication.OpenIdConnect.dll

套件:

Microsoft.AspNetCore.Authentication.OpenIdConnect v8.0.0

OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。

public class OpenIdConnectHandler : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<Microsoft.AspNetCore.Authentication.OpenIdConnect.OpenIdConnectOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignOutHandler

type OpenIdConnectHandler = class
    inherit RemoteAuthenticationHandler<OpenIdConnectOptions>
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public Class OpenIdConnectHandler
Inherits RemoteAuthenticationHandler(Of OpenIdConnectOptions)
Implements IAuthenticationSignOutHandler

繼承

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<OpenIdConnectOptions>

OpenIdConnectHandler

實作

IAuthenticationHandler IAuthenticationSignOutHandler

建構函式

OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder)	初始化 OpenIdConnectHandler 的新執行個體。
OpenIdConnectHandler(IOptionsMonitor<OpenIdConnectOptions>, ILoggerFactory, HtmlEncoder, UrlEncoder, ISystemClock)	已淘汰. 初始化 OpenIdConnectHandler 的新執行個體。

屬性

Backchannel	HttpClient取得用來與遠端識別提供者通訊的 。
ChallengeCalled	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
ClaimsIssuer	取得發出任何宣告時應該使用的簽發者。 (繼承來源 AuthenticationHandler<TOptions>)
Clock	已淘汰. 取得 ISystemClock。 (繼承來源 AuthenticationHandler<TOptions>)
Context	取得或設定 HttpContext。 (繼承來源 AuthenticationHandler<TOptions>)
CurrentUri	取得絕對目前的 URL。 (繼承來源 AuthenticationHandler<TOptions>)
Events	處理常式會在事件上呼叫方法，以在發生處理的特定時間點提供應用程式控制。 若未提供，則會提供呼叫方法時沒有作用的預設執行個體。
HtmlEncoder	取得 HtmlEncoder。
InitializeResult	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
Logger	取得 ILogger。 (繼承來源 AuthenticationHandler<TOptions>)
Options	取得或設定與此驗證處理常式相關聯的選項。 (繼承來源 AuthenticationHandler<TOptions>)
OptionsMonitor	IOptionsMonitor<TOptions>取得 ，以偵測選項的變更。 (繼承來源 AuthenticationHandler<TOptions>)
OriginalPath	取得驗證中介軟體所見的路徑。 (繼承來源 AuthenticationHandler<TOptions>)
OriginalPathBase	取得驗證中介軟體所見的路徑基底。 (繼承來源 AuthenticationHandler<TOptions>)
PriorHandler	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
Request	HttpRequest取得與目前要求相關聯的 。 (繼承來源 AuthenticationHandler<TOptions>)
Response	HttpResponse取得與目前要求相關聯的 。 (繼承來源 AuthenticationHandler<TOptions>)
Scheme	取得或設定 AuthenticationScheme 與此驗證處理常式相關聯的 。 (繼承來源 AuthenticationHandler<TOptions>)
SignInAccepted	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
SignInScheme	預設用於登入的驗證配置。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
SignOutAccepted	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
TimeProvider	取得目前的時間，主要是用於單元測試。 (繼承來源 AuthenticationHandler<TOptions>)
UrlEncoder	取得 UrlEncoder。 (繼承來源 AuthenticationHandler<TOptions>)

方法

AuthenticateAsync()	驗證目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	建構指定 targetPath 之 的絕對 URL。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	挑戰目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
CreateEventsAsync()	建立事件實例的新實例。
FinishResponseAsync()	即將傳送的回應時所呼叫的勾點 (繼承來源 AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	禁止目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	產生包含 Nonce 的 Cookie，用來將目前的遠端驗證要求相互關聯。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
GetUserInformationAsync(OpenIdConnectMessage, JwtSecurityToken, ClaimsPrincipal, AuthenticationProperties)	移至 UserInfo 端點以擷取其他宣告，並將任何唯一宣告新增至指定的身分識別。
HandleAccessDeniedErrorAsync(AuthenticationProperties)	衍生型別可能會覆寫這個方法，以處理拒絕存取的錯誤。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	允許衍生型別處理驗證。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	用來確保 HandleAuthenticateAsync 只會叫用一次。 後續的呼叫會傳回相同的驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	用來確保 HandleAuthenticateAsync 只會安全地叫用一次。 後續的呼叫會傳回相同的驗證結果。 任何例外狀況都會轉換成包含例外狀況的失敗驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	回應 401 挑戰。 將 OpenIdConnect 訊息傳送至「身分識別授權單位」以取得身分識別。
HandleForbiddenAsync(AuthenticationProperties)	覆寫這個方法來處理 Forbid。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	叫用以處理傳入的 OpenIdConnect 訊息。
HandleRemoteCallbackAsync()	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleRemoteSignOutAsync()	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。
HandleRequestAsync()	處理目前的驗證要求。
HandleSignInAsync(SignInContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleSignOutCallbackAsync()	會話結束之後，回應 OpenId 提供者的回呼。
HandleUnauthorizedAsync(ChallengeContext)	如果有問題的驗證配置在要求流程中處理驗證互動，請覆寫這個方法來處理 401 項挑戰問題。 (例如新增回應標頭，或變更 401 結果為登入頁面 302 或外部登入位置)。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	初始化處理常式，解析選項並加以驗證。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	每個要求呼叫初始化一次，以適當狀態將這個實例內容化。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	初始化 事件物件，每個要求由 InitializeAsync(AuthenticationScheme, HttpContext) 呼叫一次。 (繼承來源 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	在處理常式初始化選項/事件之後呼叫，以完成初始化本身。 (繼承來源 AuthenticationHandler<TOptions>)
RedeemAuthorizationCodeAsync(OpenIdConnectMessage)	在權杖端點兌換權杖的授權碼。
ResolveTarget(String)	解析此驗證作業轉送至的配置。 (繼承來源 AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	取得值，這個值會判斷目前的驗證要求是否應該由 HandleRequestAsync() 處理。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	將使用者重新導向至識別提供者以進行登出
SignOutAsync(SignOutContext)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	驗證目前的要求與目前的遠端驗證要求相互關聯。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	OpenIdConnectAuthenticationMiddleware 的個別要求驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)