OAuthHandler<TOptions> クラス

リファレンス

定義

名前空間:: Microsoft.AspNetCore.Authentication.OAuth

アセンブリ:: Microsoft.AspNetCore.Authentication.OAuth.dll

パッケージ:: Microsoft.AspNetCore.Authentication.OAuth v1.0.0

パッケージ:: Microsoft.AspNetCore.Authentication.OAuth v1.1.0

パッケージ:: Microsoft.AspNetCore.Authentication.OAuth v2.0.0

パッケージ:: Microsoft.AspNetCore.Authentication.OAuth v2.1.0

パッケージ:: Microsoft.AspNetCore.Authentication.OAuth v2.2.0

パッケージ:: Microsoft.AspNetCore.App.Ref v3.0.1

パッケージ:: Microsoft.AspNetCore.App.Ref v3.1.10

パッケージ:: Microsoft.AspNetCore.App.Ref v5.0.0

パッケージ:: Microsoft.AspNetCore.App.Ref v6.0.6

パッケージ:: Microsoft.AspNetCore.App.Ref v7.0.5

パッケージ:: Microsoft.AspNetCore.App.Ref v8.0.0

パッケージ:: Microsoft.AspNetCore.App.Ref v9.0.0-rc.2.24474.3

ソース:: OAuthHandler.cs

ソース:: OAuthHandler.cs

ソース:: OAuthHandler.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

OAuth をサポートする認証ハンドラー。

generic <typename TOptions>
 where TOptions : OAuthOptionspublic ref class OAuthHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<TOptions>

generic <typename TOptions>
 where TOptions : OAuthOptionsgcnew()public ref class OAuthHandler : Microsoft::AspNetCore::Authentication::RemoteAuthenticationHandler<TOptions>

public class OAuthHandler<TOptions> : Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions> where TOptions : OAuthOptions

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

type OAuthHandler<'Options (requires 'Options :> OAuthOptions)> = class
    inherit RemoteAuthenticationHandler<'Options (requires 'Options :> OAuthOptions)>

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>(HttpClient)	OAuth をサポートする認証ハンドラー。
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	古い. OAuthHandler<TOptions>の新しいインスタンスを初期化します。
OAuthHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	OAuthHandler<TOptions>の新しいインスタンスを初期化します。

プロパティ

Backchannel	リモート認証プロバイダーとの通信に使用する HttpClient インスタンスを取得します。
ChallengeCalled	OAuth をサポートする認証ハンドラー。 (継承元 AuthenticationHandler<TOptions>)
ClaimsIssuer	要求が発行されたときに使用する発行者を取得します。 (継承元 AuthenticationHandler<TOptions>)
Clock	古い. ISystemClockを取得します。 (継承元 AuthenticationHandler<TOptions>)
Context	HttpContextを取得または設定します。 (継承元 AuthenticationHandler<TOptions>)
CurrentUri	現在の絶対 URL を取得します。 (継承元 AuthenticationHandler<TOptions>)
Events	ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。
Events	ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。 (継承元 RemoteAuthenticationHandler<TOptions>)
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 を構築します。
BuildChallengeUrl(AuthenticationProperties, String)	OAuth をサポートする認証ハンドラー。
BuildRedirectUri(String)	指定した `targetPath`の絶対 URL を構築します。 (継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	現在の要求にチャレンジします。 (継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	OAuth をサポートする認証ハンドラー。 (継承元 AuthenticationHandler<TOptions>)
CreateEventsAsync()	イベントインスタンスの新しいインスタンスを作成します。
CreateEventsAsync()	イベントインスタンスの新しいインスタンスを作成します。 (継承元 RemoteAuthenticationHandler<TOptions>)
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	OAuth をサポートする認証ハンドラー。
CreateTicketAsync(ClaimsIdentity, AuthenticationProperties, OAuthTokenResponse)	指定した `tokens`から AuthenticationTicket を作成します。
ExchangeCodeAsync(OAuthCodeExchangeContext)	リモートプロバイダーからの承認トークンの承認コードを交換します。
ExchangeCodeAsync(String, String)	OAuth をサポートする認証ハンドラー。
FinishResponseAsync()	応答が送信されるときに呼び出されるフック (継承元 AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	現在の要求を禁止します。 (継承元 AuthenticationHandler<TOptions>)
FormatScope()	Scope プロパティの書式を設定します。
FormatScope(IEnumerable<String>)	OAuth スコープの一覧を書式設定します。
GenerateCorrelationId(AuthenticationProperties)	現在のリモート認証要求を関連付けるために使用される nonce を含む Cookie を生成します。 (継承元 RemoteAuthenticationHandler<TOptions>)
GenerateCorrelationId(AuthenticationProperties)	OAuth をサポートする認証ハンドラー。 (継承元 RemoteAuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	OAuth をサポートする認証ハンドラー。 (継承元 AuthenticationHandler<TOptions>)
HandleAccessDeniedErrorAsync(AuthenticationProperties)	派生型は、アクセス拒否エラーを処理するためにこのメソッドをオーバーライドできます。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	派生型が認証を処理できるようにします。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。以降の呼び出しでは、同じ認証結果が返されます。 (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。後続の呼び出しでは、同じ認証結果が返されます。例外はすべて、例外を含む失敗した認証結果に変換されます。 (継承元 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログインページまたは外部サインインの場所の 302 への 401 の結果の変更など)。
HandleChallengeAsync(AuthenticationProperties)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログインページまたは外部サインインの場所の 302 への 401 の結果の変更など)。 (継承元 AuthenticationHandler<TOptions>)
HandleForbiddenAsync(AuthenticationProperties)	Forbid を処理するには、このメソッドをオーバーライドします。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	OAuth をサポートする認証ハンドラー。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleRemoteAuthenticateAsync()	ID プロバイダーでユーザー ID を認証します。このメソッドは、CallbackPath によって定義されたエンドポイントで要求を処理します。
HandleRemoteCallbackAsync()	OAuth をサポートする認証ハンドラー。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleRequestAsync()	現在の認証要求を処理します。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleSignInAsync(SignInContext)	OAuth をサポートする認証ハンドラー。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	OAuth をサポートする認証ハンドラー。 (継承元 RemoteAuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	OAuth をサポートする認証ハンドラー。
HandleUnauthorizedAsync(ChallengeContext)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログインページまたは外部サインインの場所の 302 への 401 の結果の変更など)。 (継承元 AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	ハンドラーを初期化し、オプションを解決して検証します。 (継承元 AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Initialize は要求ごとに 1 回呼び出され、適切な状態でこのインスタンスをコンテキスト化します。 (継承元 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	InitializeAsync(AuthenticationScheme, HttpContext)によって要求ごとに 1 回呼び出されるイベントオブジェクトを初期化します。 (継承元 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>)

適用対象

次の方法で共有

OAuthHandler<TOptions> クラス

定義

型パラメーター

コンストラクター

プロパティ

メソッド

適用対象

フィードバック

その他のリソース