AuthenticationHandler<TOptions> クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。
generic <typename TOptions>
where TOptions : AuthenticationOptionspublic ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Http::Features::Authentication::IAuthenticationHandler
generic <typename TOptions>
where TOptions : AuthenticationSchemeOptionsgcnew()public ref class AuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::IAuthenticationHandler
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Http.Features.Authentication.IAuthenticationHandler where TOptions : AuthenticationOptions
public abstract class AuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.IAuthenticationHandler where TOptions : AuthenticationSchemeOptions, new()
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationOptions)> = class
interface IAuthenticationHandler
type AuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
interface IAuthenticationHandler
Public 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) |
指定した の絶対 URL を構築します |
ChallengeAsync(AuthenticationProperties) |
現在の要求にチャレンジします。 |
ChallengeAsync(ChallengeContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
CreateEventsAsync() |
イベント インスタンスの新しいインスタンスを作成します。 |
FinishResponseAsync() |
応答が送信されるときに呼び出されるフック |
ForbidAsync(AuthenticationProperties) |
現在の要求を禁止します。 |
GetDescriptions(DescribeSchemesContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
HandleAuthenticateAsync() |
派生型が認証を処理できるようにします。 |
HandleAuthenticateOnceAsync() |
HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。 |
HandleAuthenticateOnceSafeAsync() |
HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。 例外は、例外を含む失敗した認証結果に変換されます。 |
HandleChallengeAsync(AuthenticationProperties) |
問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加、または、ログインページまたは外部サインイン場所の 401 結果を 302 に変更するなど)。 |
HandleForbiddenAsync(AuthenticationProperties) |
Forbid を処理するには、このメソッドをオーバーライドします。 |
HandleForbiddenAsync(ChallengeContext) |
禁止されているチャレンジに対処するには、このメソッドをオーバーライドします。 |
HandleRequestAsync() |
初期化の完了後、一般的なコードによって一度呼び出されます。 認証ミドルウェアが特に既知のパスに直接応答する場合は、この仮想をオーバーライドし、要求パスを既知のパスと比較し、必要に応じて応答情報を指定し、さらに処理を停止するには true を指定する必要があります。 |
HandleSignInAsync(SignInContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
HandleSignOutAsync(SignOutContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
HandleUnauthorizedAsync(ChallengeContext) |
問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、このメソッドをオーバーライドして 401 チャレンジの懸念に対処します。 (応答ヘッダーの追加、または、ログインページまたは外部サインイン場所の 401 結果を 302 に変更するなど)。 |
InitializeAsync(AuthenticationScheme, HttpContext) |
ハンドラーを初期化し、オプションを解決して検証します。 |
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder) |
Initialize は、適切な状態でこのインスタンスをコンテキスト化するために、要求ごとに 1 回呼び出されます。 |
InitializeEventsAsync() |
によって要求ごとに 1 回呼び出されるイベント オブジェクトを InitializeAsync(AuthenticationScheme, HttpContext)初期化します。 |
InitializeHandlerAsync() |
ハンドラーがそれ自体の初期化を完了するためにオプション/イベントが初期化された後に呼び出されます。 |
ResolveTarget(String) |
この認証操作が転送されるスキームを解決します。 |
ShouldHandleScheme(String, Boolean) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
SignInAsync(SignInContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
SignOutAsync(SignOutContext) |
を実装 IAuthenticationHandlerするためのオピニオン化された抽象化。 |
適用対象
フィードバック
https://aka.ms/ContentUserFeedback」を参照してください。
以下は間もなく提供いたします。2024 年を通じて、コンテンツのフィードバック メカニズムとして GitHub の issue を段階的に廃止し、新しいフィードバック システムに置き換えます。 詳細については、「フィードバックの送信と表示