AuthenticationHandler<TOptions> クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication

アセンブリ:

Microsoft.AspNetCore.Authentication.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

ソース:

AuthenticationHandler.cs

IAuthenticationHandlerを実装するためのオピニオン抽象化。

public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()

type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    interface IAuthenticationHandler

Public MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler

型パラメーター

TOptions

認証ハンドラーの構成に使用するオプションの種類。

継承

Object

AuthenticationHandler<TOptions>

派生

Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerHandler

Microsoft.AspNetCore.Authentication.Negotiate.NegotiateHandler

Microsoft.AspNetCore.Authentication.RemoteAuthenticationHandler<TOptions>

Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>

実装

IAuthenticationHandler

コンストラクター

AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder)	AuthenticationHandler<TOptions>の新しいインスタンスを初期化します。
AuthenticationHandler<TOptions>(IOptionsMonitor<TOptions>, ILoggerFactory, UrlEncoder, ISystemClock)	古い. AuthenticationHandler<TOptions>の新しいインスタンスを初期化します。

プロパティ

ClaimsIssuer	要求が発行されたときに使用する発行者を取得します。
Clock	古い. ISystemClockを取得します。
Context	HttpContextを取得または設定します。
CurrentUri	現在の絶対 URL を取得します。
Events	ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。 指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。
Logger	ILoggerを取得します。
Options	この認証ハンドラーに関連付けられているオプションを取得または設定します。
OptionsMonitor	オプションの変更を検出する IOptionsMonitor<TOptions> を取得します。
OriginalPath	認証ミドルウェアに表示されるパスを取得します。
OriginalPathBase	認証ミドルウェアによって表示されるパス ベースを取得します。
Request	現在の要求に関連付けられている HttpRequest を取得します。
Response	現在の要求に関連付けられている HttpResponse を取得します。
Scheme	この認証ハンドラーに関連付けられている AuthenticationScheme を取得または設定します。
TimeProvider	現在の時刻 (主に単体テスト用) を取得します。
UrlEncoder	UrlEncoderを取得します。

メソッド

AuthenticateAsync()	現在の要求を認証します。
BuildRedirectUri(String)	指定した targetPathの絶対 URL を構築します。
ChallengeAsync(AuthenticationProperties)	現在の要求にチャレンジします。
CreateEventsAsync()	イベント インスタンスの新しいインスタンスを作成します。
ForbidAsync(AuthenticationProperties)	現在の要求を禁止します。
HandleAuthenticateAsync()	派生型が認証を処理できるようにします。
HandleAuthenticateOnceAsync()	HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。
HandleAuthenticateOnceSafeAsync()	HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。 後続の呼び出しでは、同じ認証結果が返されます。 例外はすべて、例外を含む失敗した認証結果に変換されます。
HandleChallengeAsync(AuthenticationProperties)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログイン ページまたは外部サインインの場所の 302 への 401 の結果の変更など)。
HandleForbiddenAsync(AuthenticationProperties)	Forbid を処理するには、このメソッドをオーバーライドします。
InitializeAsync(AuthenticationScheme, HttpContext)	ハンドラーを初期化し、オプションを解決して検証します。
InitializeEventsAsync()	InitializeAsync(AuthenticationScheme, HttpContext)によって要求ごとに 1 回呼び出されるイベント オブジェクトを初期化します。
InitializeHandlerAsync()	ハンドラーが自身の初期化を完了するためにオプション/イベントが初期化された後に呼び出されます。
ResolveTarget(String)	この認証操作が転送されるスキームを解決します。