SignInAuthenticationHandler<TOptions> クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication

アセンブリ:

Microsoft.AspNetCore.Authentication.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

SignInAsync のサポートを追加します

generic <typename TOptions>
 where TOptions : AuthenticationSchemeOptionsgcnew()public ref class SignInAuthenticationHandler abstract : Microsoft::AspNetCore::Authentication::SignOutAuthenticationHandler<TOptions>, Microsoft::AspNetCore::Authentication::IAuthenticationSignInHandler

public abstract class SignInAuthenticationHandler<TOptions> : Microsoft.AspNetCore.Authentication.SignOutAuthenticationHandler<TOptions>, Microsoft.AspNetCore.Authentication.IAuthenticationSignInHandler where TOptions : AuthenticationSchemeOptions, new()

type SignInAuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))> = class
    inherit SignOutAuthenticationHandler<'Options (requires 'Options :> AuthenticationSchemeOptions and 'Options : (new : unit -> 'Options))>
    interface IAuthenticationSignInHandler
    interface IAuthenticationSignOutHandler
    interface IAuthenticationHandler

Public MustInherit Class SignInAuthenticationHandler(Of TOptions)
Inherits SignOutAuthenticationHandler(Of TOptions)
Implements IAuthenticationSignInHandler

型パラメーター

TOptions

継承

Object

AuthenticationHandler<TOptions>

SignOutAuthenticationHandler<TOptions>

SignInAuthenticationHandler<TOptions>

派生

Microsoft.AspNetCore.Authentication.Cookies.CookieAuthenticationHandler

Microsoft.AspNetCore.Authentication.PolicySchemeHandler

実装

IAuthenticationHandler IAuthenticationSignInHandler IAuthenticationSignOutHandler

コンストラクター

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

プロパティ

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

メソッド

AuthenticateAsync()	現在の要求を認証します。 (継承元 AuthenticationHandler<TOptions>)
AuthenticateAsync(AuthenticateContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
BuildRedirectUri(String)	指定した の絶対 URL を構築します targetPath。 (継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(AuthenticationProperties)	現在の要求にチャレンジします。 (継承元 AuthenticationHandler<TOptions>)
ChallengeAsync(ChallengeContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
CreateEventsAsync()	イベント インスタンスの新しいインスタンスを作成します。 (継承元 AuthenticationHandler<TOptions>)
FinishResponseAsync()	応答が送信されるときに呼び出されるフック (継承元 AuthenticationHandler<TOptions>)
ForbidAsync(AuthenticationProperties)	現在の要求を禁止します。 (継承元 AuthenticationHandler<TOptions>)
GetDescriptions(DescribeSchemesContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateAsync()	派生型が認証を処理できるようにします。 (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceAsync()	HandleAuthenticateAsync が 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。 (継承元 AuthenticationHandler<TOptions>)
HandleAuthenticateOnceSafeAsync()	HandleAuthenticateAsync が安全に 1 回だけ呼び出されるようにするために使用されます。 以降の呼び出しでは、同じ認証結果が返されます。 例外は、例外を含む失敗した認証結果に変換されます。 (継承元 AuthenticationHandler<TOptions>)
HandleChallengeAsync(AuthenticationProperties)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、この方法をオーバーライドして 401 チャレンジの問題に対処します。 (応答ヘッダーの追加、または、ログインページまたは外部サインイン場所の 401 結果を 302 に変更するなど)。 (継承元 AuthenticationHandler<TOptions>)
HandleForbiddenAsync(AuthenticationProperties)	Forbid を処理するには、このメソッドをオーバーライドします。 (継承元 AuthenticationHandler<TOptions>)
HandleForbiddenAsync(ChallengeContext)	このメソッドをオーバーライドして、禁止されているチャレンジに対処します。 (継承元 AuthenticationHandler<TOptions>)
HandleRequestAsync()	初期化の完了後、一般的なコードによって一度呼び出されます。 認証ミドルウェアが特に既知のパスに直接応答する場合は、この仮想をオーバーライドし、要求パスを既知のパスと比較し、必要に応じて応答情報を指定し、true を指定してそれ以上の処理を停止する必要があります。 (継承元 AuthenticationHandler<TOptions>)
HandleSignInAsync(ClaimsPrincipal, AuthenticationProperties)	SignIn を処理するには、このメソッドをオーバーライドします。
HandleSignInAsync(SignInContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
HandleSignOutAsync(AuthenticationProperties)	SignOut を処理するには、このメソッドをオーバーライドします。 (継承元 SignOutAuthenticationHandler<TOptions>)
HandleSignOutAsync(SignOutContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
HandleUnauthorizedAsync(ChallengeContext)	問題の認証スキームが要求フローの一部として認証の相互作用を処理する場合は、この方法をオーバーライドして 401 チャレンジの問題に対処します。 (応答ヘッダーの追加、または、ログインページまたは外部サインイン場所の 401 結果を 302 に変更するなど)。 (継承元 AuthenticationHandler<TOptions>)
InitializeAsync(AuthenticationScheme, HttpContext)	ハンドラーを初期化し、オプションを解決して検証します。 (継承元 AuthenticationHandler<TOptions>)
InitializeAsync(TOptions, HttpContext, ILogger, UrlEncoder)	Initialize は、適切な状態でこのインスタンスをコンテキスト化するために、要求ごとに 1 回呼び出されます。 (継承元 AuthenticationHandler<TOptions>)
InitializeEventsAsync()	によって要求ごとに 1 回呼び出される events オブジェクトを InitializeAsync(AuthenticationScheme, HttpContext)初期化します。 (継承元 AuthenticationHandler<TOptions>)
InitializeHandlerAsync()	ハンドラーがそれ自体の初期化を完了するために、オプション/イベントが初期化された後に呼び出されます。 (継承元 AuthenticationHandler<TOptions>)
ResolveTarget(String)	この認証操作が転送されるスキームを解決します。 (継承元 AuthenticationHandler<TOptions>)
ShouldHandleScheme(String, Boolean)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
SignInAsync(ClaimsPrincipal, AuthenticationProperties)	サインインを処理します。
SignInAsync(SignInContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)
SignOutAsync(AuthenticationProperties)	サインアウト動作。 (継承元 SignOutAuthenticationHandler<TOptions>)
SignOutAsync(SignOutContext)	SignInAsync のサポートを追加します (継承元 AuthenticationHandler<TOptions>)