OAuthHandler<TOptions> 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.OAuth

組件:

Microsoft.AspNetCore.Authentication.OAuth.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

支援 OAuth 的驗證處理常式。

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions, new()

type OAuthHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions and 'Options : (new : unit -> 'Options))>

Public Class OAuthHandler(Of TOptions)
Inherits RemoteAuthenticationHandler(Of TOptions)

類型參數

TOptions

選項的類型。

繼承

Object

AuthenticationHandler<TOptions>

RemoteAuthenticationHandler<TOptions>

OAuthHandler<TOptions>

衍生

Microsoft.AspNetCore.Authentication.Facebook.FacebookHandler

Microsoft.AspNetCore.Authentication.Google.GoogleHandler

Microsoft.AspNetCore.Authentication.MicrosoftAccount.MicrosoftAccountHandler

建構函式

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

屬性

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

方法

AuthenticateAsync()	驗證目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
BuildChallengeUrl(AuthenticationProperties, String)	建構 OAuth 挑戰 URL。
BuildRedirectUri(String)	建構指定 targetPath 之 的絕對 URL。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	挑戰目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
CreateEventsAsync()	建立事件實例的新實例。
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	AuthenticationTicket從指定的 tokens 建立 。
ExchangeCodeAsync(OAuthCodeExchangeContext)	從遠端提供者交換授權權杖的授權碼。
FinishResponseAsync()	即將傳送回應時所呼叫的勾點 (繼承來源 AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	禁止目前的要求。 (繼承來源 AuthenticationHandler<TOptions>)
FormatScope()	Scope格式化 屬性。
FormatScope(IEnumerable<String>)	格式化 OAuth 範圍清單。
GenerateCorrelationId(AuthenticationProperties)	產生 Cookie，其中包含用來使目前遠端驗證要求相互關聯的 nonce。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	衍生類型可能會覆寫這個方法，以處理拒絕存取的錯誤。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	允許衍生類型處理驗證。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	用來確保 HandleAuthenticateAsync 只會叫用一次。 後續呼叫會傳回相同的驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	用來確保 HandleAuthenticateAsync 只會安全地叫用一次。 後續呼叫會傳回相同的驗證結果。 任何例外狀況都會轉換成包含例外狀況的失敗驗證結果。 (繼承來源 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	如果有問題的驗證配置在要求流程中處理驗證互動，請覆寫此方法來處理 401 挑戰考慮。 (例如新增回應標頭，或變更 401 結果為登入頁面 302 或外部登入位置)。
HandleForbiddenAsync(AuthenticationProperties)	覆寫此方法以處理 Forbid。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	使用識別提供者驗證使用者身分識別。 方法會處理 CallbackPath 所定義端點上的要求。
HandleRemoteCallbackAsync()	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	處理目前的驗證要求。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
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>)
ResolveTarget(String)	解析此驗證作業轉送至的配置。 (繼承來源 AuthenticationHandler<TOptions>)
ShouldHandleRequestAsync()	取得值，這個值會判斷目前的驗證要求是否應該由 HandleRequestAsync() 處理。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
SignInAsync(SignInContext)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	支援 OAuth 的驗證處理常式。 (繼承來源 AuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	驗證目前的要求是否與目前的遠端驗證要求相互關聯。 (繼承來源 RemoteAuthenticationHandler<TOptions>)
ValidateCorrelationId(AuthenticationProperties)	支援 OAuth 的驗證處理常式。 (繼承來源 RemoteAuthenticationHandler<TOptions>)