CookieAuthenticationOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Authentication.Cookies

アセンブリ:

Microsoft.AspNetCore.Authentication.Cookies.dll

パッケージ:

Microsoft.AspNetCore.App.Ref v8.0.0

CookieAuthenticationOptions の構成オプション。

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Authentication::AuthenticationSchemeOptions

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Authentication.AuthenticationSchemeOptions

type CookieAuthenticationOptions = class
    inherit AuthenticationSchemeOptions

Public Class CookieAuthenticationOptions
Inherits AuthenticationSchemeOptions

継承

Object

AuthenticationSchemeOptions

CookieAuthenticationOptions

コンストラクター

CookieAuthenticationOptions()

既定値で初期化されるオプションのインスタンスを作成します

プロパティ

AccessDeniedPath	AccessDeniedPath プロパティは、ForbidAsync を処理するときにリダイレクト ターゲットのハンドラーによって使用されます。
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationSchemeOptions)
Cookie	Cookie の作成に使用される設定を決定します。
CookieManager	Cookie を要求から取得したり応答に設定したりするときに使用するコンポーネント。 既定では ChunkingCookieManager が使用されます。
DataProtectionProvider	設定した場合、これは CookieAuthenticationHandler によってデータ保護に使用されます。
Events	「プロバイダー」は、スタートアップ時にアプリケーションによって作成されたオブジェクトのインスタンスに割り当てることができます。 ハンドラーは、処理が発生している特定のポイントでアプリケーション コントロールを提供するプロバイダーのメソッドを呼び出します。 指定されていない場合、メソッドの呼び出し時に、何もしない既定のインスタンスが提供されます。
EventsType	が設定されている場合は、 プロパティの代わりに Events インスタンスを取得するためのサービスの種類として が使用されます。 (継承元 AuthenticationSchemeOptions)
ExpireTimeSpan	Cookie に格納されている認証チケットが作成された時点から有効な状態を維持する時間を制御します。 有効期限情報は、保護された Cookie チケットに格納されます。 そのため、有効期限が切れた Cookie は、ブラウザーが消去した後にサーバーに渡された場合でも無視されます。 これは、 の Expires値とは別で、ブラウザーが Cookie を保持する期間を指定します。
ForwardAuthenticate	設定されている場合、このスキームで AuthenticateAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.AuthenticateAsync("ThisScheme") => Context.AuthenticateAsync("ForwardAuthenticateValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardChallenge	設定されている場合、このスキームで ChallengeAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ChallengeAsync("ThisScheme") => Context.ChallengeAsync("ForwardChallengeValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardDefault	設定されている場合、認証ハンドラーが既定ですべての認証操作を に転送する既定のスキームを指定します。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardDefaultSelector	認証ハンドラーが既定ですべての認証操作をに転送する必要がある現在の要求の既定のスキームを選択するために使用されます。 既定の転送ロジックでは、最も具体的な ForwardAuthenticate/Challenge/Forbid/SignIn/SignOut 設定が最初にチェックされ、次に ForwardDefaultSelector、ForwardDefault が確認されます。 最初の null 以外の結果は、転送先のターゲット スキームとして使用されます。 (継承元 AuthenticationSchemeOptions)
ForwardForbid	設定されている場合、このスキームで ForbidAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.ForbidAsync("ThisScheme") => Context.ForbidAsync("ForwardForbidValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignIn	設定されている場合、このスキームで SignInAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignInAsync("ThisScheme") => Context.SignInAsync("ForwardSignInValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
ForwardSignOut	設定されている場合、このスキームで SignOutAsync 呼び出しを転送するターゲット スキームを指定します。 たとえば、Context.SignOutAsync("ThisScheme") => Context.SignOutAsync("ForwardSignOutValue");ターゲットを現在のスキームに設定して、転送を無効にし、通常の処理を許可します。 (継承元 AuthenticationSchemeOptions)
LoginPath	LoginPath プロパティは、ChallengeAsync を処理するときにリダイレクト ターゲットのハンドラーによって使用されます。 ReturnUrlParameter によって指定されたクエリ文字列パラメーターとして LoginPath に追加される現在の URL。 LoginPath への要求で新しい SignIn ID が付与されると、ReturnUrlParameter 値を使用してブラウザーを元の URL にリダイレクトします。
LogoutPath	LogoutPath がハンドラーに指定されている場合、そのパスへの要求は ReturnUrlParameter に基づいてリダイレクトされます。
ReturnUrlParameter	ReturnUrlParameter は、チャレンジ中にハンドラーによって追加されるクエリ文字列パラメーターの名前を決定します。 これは、アクションの実行後に元の URL に返すために、要求がログイン パスまたはログアウト パスに到着したときに検索されるクエリ文字列パラメーターでもあります。
SessionStore	複数の要求にわたって ID を格納するオプションのコンテナー。 使用した場合、セッション識別子のみがクライアントに送信されます。 ID がきわめて大きいことによって生じる可能性のある問題を軽減することができます。
SlidingExpiration	SlidingExpiration は true に設定され、有効期限ウィンドウの半分以上の要求を処理するたびに、新しい有効期限で新しい Cookie を再発行するようにハンドラーに指示します。
TicketDataFormat	TicketDataFormat は、Cookie 値に格納されている ID とその他のプロパティを保護または保護解除するために使用します。 指定されていない場合は、 を使用して DataProtectionProvider作成されます。
TimeProvider	テストに使用されます。 (継承元 AuthenticationSchemeOptions)

メソッド

Validate()	オプションが有効であることを確認します。 問題がなければ例外をスローする必要があります。 (継承元 AuthenticationSchemeOptions)
Validate(String)	オプションが特定のスキームに対して有効であることを確認します (継承元 AuthenticationSchemeOptions)