AuthenticationHandler<TOptions> クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
IAuthenticationHandlerを実装するためのオピニオン抽象化。
generic <typename TOptions>
where TOptions : AuthenticationOptionspublic ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Http::Features::Authentication::IAuthenticationHandlergeneric <typename TOptions>
where TOptions : AuthenticationSchemeOptionsgcnew()public ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::IAuthenticationHandlerpublic abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Http.Features.Authentication.IAuthenticationHandler where TOptions : AuthenticationOptionspublic abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()type AuthenticationHandler<'Options (requires 'Options :> AuthenticationOptions)> = class
interface IAuthenticationHandlertype AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
interface IAuthenticationHandlerPublic MustInherit Class AuthenticationHandler(Of TOptions)
Implements IAuthenticationHandler型パラメーター
- TOptions
認証ハンドラーの構成に使用するオプションの種類。
- 継承
-
AuthenticationHandler<TOptions>
- 派生
- 実装
コンストラクター
プロパティ
| ChallengeCalled |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| ClaimsIssuer |
要求が発行されたときに使用する発行者を取得します。 |
| Clock |
古い.
ISystemClockを取得します。 |
| Context |
HttpContextを取得または設定します。 |
| CurrentUri |
現在の絶対 URL を取得します。 |
| Events |
ハンドラーは、処理が発生している特定のポイントでアプリケーション制御を提供するイベントに対してメソッドを呼び出します。 指定されていない場合は、メソッドが呼び出されたときに何も行わない既定のインスタンスが提供されます。 |
| InitializeResult |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| Logger |
ILoggerを取得します。 |
| Options |
この認証ハンドラーに関連付けられているオプションを取得または設定します。 |
| OptionsMonitor |
オプションの変更を検出する IOptionsMonitor<TOptions> を取得します。 |
| OriginalPath |
認証ミドルウェアに表示されるパスを取得します。 |
| OriginalPathBase |
認証ミドルウェアによって表示されるパス ベースを取得します。 |
| PriorHandler |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| Request |
現在の要求に関連付けられている HttpRequest を取得します。 |
| Response |
現在の要求に関連付けられている HttpResponse を取得します。 |
| Scheme |
この認証ハンドラーに関連付けられている AuthenticationScheme を取得または設定します。 |
| SignInAccepted |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| SignOutAccepted |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| TimeProvider |
現在の時刻 (主に単体テスト用) を取得します。 |
| UrlEncoder |
UrlEncoderを取得します。 |
メソッド
| AuthenticateAsync() |
現在の要求を認証します。 |
| AuthenticateAsync(AuthenticateContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| BuildRedirectUri(String) |
指定した |
| ChallengeAsync(AuthenticationProperties) |
現在の要求にチャレンジします。 |
| ChallengeAsync(ChallengeContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| CreateEventsAsync() |
イベント インスタンスの新しいインスタンスを作成します。 |
| FinishResponseAsync() |
応答が送信されるときに呼び出されるフック |
| ForbidAsync(AuthenticationProperties) |
現在の要求を禁止します。 |
| GetDescriptions(DescribeSchemesContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| HandleAuthenticateAsync() |
派生型が認証を処理できるようにします。 |
| HandleAuthenticateOnceAsync() |
HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。 |
| HandleAuthenticateOnceSafeAsync() |
HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。 後続の呼び出しでは、同じ認証結果が返されます。 例外はすべて、例外を含む失敗した認証結果に変換されます。 |
| HandleChallengeAsync(AuthenticationProperties) |
問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログイン ページまたは外部サインインの場所の 302 への 401 の結果の変更など)。 |
| HandleForbiddenAsync(AuthenticationProperties) |
Forbid を処理するには、このメソッドをオーバーライドします。 |
| HandleForbiddenAsync(ChallengeContext) |
禁止されているチャレンジに対処するには、このメソッドをオーバーライドします。 |
| HandleRequestAsync() |
初期化後に共通コードによって 1 回呼び出されます。 認証ミドルウェアが特定の既知のパスに直接応答する場合は、この仮想をオーバーライドし、要求パスを既知のパスと比較し、必要に応じて応答情報を指定し、true を指定してさらなる処理を停止する必要があります。 |
| HandleSignInAsync(SignInContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| HandleSignOutAsync(SignOutContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| HandleUnauthorizedAsync(ChallengeContext) |
問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加や、ログイン ページまたは外部サインインの場所の 302 への 401 の結果の変更など)。 |
| InitializeAsync(AuthenticationScheme, HttpContext) |
ハンドラーを初期化し、オプションを解決して検証します。 |
| InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder) |
Initialize は要求ごとに 1 回呼び出され、適切な状態でこのインスタンスをコンテキスト化します。 |
| InitializeEventsAsync() |
InitializeAsync(AuthenticationScheme, HttpContext)によって要求ごとに 1 回呼び出されるイベント オブジェクトを初期化します。 |
| InitializeHandlerAsync() |
ハンドラーが自身の初期化を完了するためにオプション/イベントが初期化された後に呼び出されます。 |
| ResolveTarget(String) |
この認証操作が転送されるスキームを解決します。 |
| ShouldHandleScheme(String, Boolean) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| SignInAsync(SignInContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |
| SignOutAsync(SignOutContext) |
IAuthenticationHandlerを実装するためのオピニオン抽象化。 |