CookieAuthenticationOptions クラス

定義

名前空間:

Microsoft.AspNetCore.Builder

アセンブリ:

Microsoft.AspNetCore.Authentication.Cookies.dll

パッケージ:

Microsoft.AspNetCore.Authentication.Cookies v1.1.0

CookieAuthenticationMiddleware の構成オプション。

public ref class CookieAuthenticationOptions : Microsoft::AspNetCore::Builder::AuthenticationOptions, Microsoft::Extensions::Options::IOptions<Microsoft::AspNetCore::Builder::CookieAuthenticationOptions ^>

public class CookieAuthenticationOptions : Microsoft.AspNetCore.Builder.AuthenticationOptions, Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Builder.CookieAuthenticationOptions>

type CookieAuthenticationOptions = class
    inherit AuthenticationOptions
    interface IOptions<CookieAuthenticationOptions>

Public Class CookieAuthenticationOptions
Inherits AuthenticationOptions
Implements IOptions(Of CookieAuthenticationOptions)

継承

Object

AuthenticationOptions

CookieAuthenticationOptions

実装

IOptions<CookieAuthenticationOptions>

コンストラクター

CookieAuthenticationOptions()

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

プロパティ

AccessDeniedPath	AccessDeniedPath プロパティは、送信 403 Forbidden 状態コードを指定されたパスへの 302 リダイレクトに変更する必要があることをミドルウェアに通知します。
AuthenticationScheme	オプションの AuthenticationScheme は、特定の認証スキームの論理名に対応します。 同じ種類の認証ミドルウェアを複数回パイプラインで使用するために、異なる値を割り当てることができます。 (継承元 AuthenticationOptions)
AutomaticAuthenticate	true の場合、認証ミドルウェアは、入ってくる要求ユーザーを変更します。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ ID を提供します。 (継承元 AuthenticationOptions)
AutomaticChallenge	true の場合、認証ミドルウェアは自動チャレンジを処理する必要があります。 false の場合、認証ミドルウェアは AuthenticationScheme によって明示的に示された場合にのみ応答を変更します。 (継承元 AuthenticationOptions)
ClaimsIssuer	作成されるすべての要求に使用する発行者を取得または設定します。 (継承元 AuthenticationOptions)
CookieDomain	Cookie の作成に使用されるドメインを決定します。 既定で提供されません。
CookieHttpOnly	ブラウザーでクライアント側 JavaScript から Cookie にアクセスできるようにする必要があるかどうかを決定します。 既定は true です。Cookie は HTTP 要求にのみ渡され、ページ上のスクリプトから使用できないことを意味します。
CookieManager	Cookie を要求から取得したり応答に設定したりするときに使用するコンポーネント。 既定では ChunkingCookieManager が使用されます。
CookieName	ID を保持するために使用する Cookie 名を決定します。 既定値は です。AspNetCore.Cookies" この値は、AuthenticationScheme の名前を変更する場合に変更する必要があります(特に、システムで Cookie 認証ミドルウェアが複数回使用されている場合)。
CookiePath	Cookie の作成に使用されるパスを決定します。 ブラウザーの互換性が最も高い場合、既定値は "/" です。
CookieSecure	Cookie を HTTPS 要求でのみ送信する必要があるかどうかを決定します。 既定は、SignIn を実行するページも HTTPS の場合に、Cookie を HTTPS 要求に制限することです。 HTTPS サインイン ページがあり、サイトの一部が HTTP の場合、この値を変更する必要がある場合があります。
DataProtectionProvider	設定した場合、これはデータ保護のために CookieAuthenticationMiddleware によって使用されます。
Description	アプリケーションから使用可能な、認証の種類に関する追加情報。 (継承元 AuthenticationOptions)
Events	「プロバイダー」は、スタートアップ時にアプリケーションによって作成されたオブジェクトのインスタンスに割り当てることができます。 ミドルウェアはプロバイダーのメソッドを呼び出します。これにより、処理が発生している特定のポイントでアプリケーション制御が提供されます。 指定されていない場合、メソッドの呼び出し時に、何もしない既定のインスタンスが提供されます。
ExpireTimeSpan	Cookie を作成された時点から、有効なままにする時間を制御します。 有効期限情報は保護された Cookie チケット内にあります。 そのため、有効期限が切れた Cookie は、ブラウザーによって削除されるはずだった期限後にサーバーに渡されても無視されます。
LoginPath	LoginPath プロパティは、ミドルウェアに対し、送信 401 Unauthorized ステータス コードを指定されたログイン パスへの 302 リダイレクトに変更する必要があることを通知します。 401 を生成した現在の URL が、ReturnUrlParameter によって名前が付けられたクエリ文字列パラメーターとして、LoginPath に追加されます。 LoginPath への要求で新しい SignIn ID が付与されると、ReturnUrlParameter 値を使用してブラウザーをリダイレクトし直します は、元の未承認の状態コードの原因となった URL に移動します。
LogoutPath	LogoutPath が指定されている場合、ミドルウェアはそのパスへの要求を、ReturnUrlParameter に基づいてリダイレクトします。
ReturnUrlParameter	ReturnUrlParameter は、401 Unauthorized ステータス コードがログイン パスへの 302 リダイレクトに変更される際に、ミドルウェアによって付加されるクエリ文字列パラメーターの名前を決定します。 これは、アクションの実行後に元の URL に返すために、要求がログイン パスまたはログアウト パスに到着したときに検索されるクエリ文字列パラメーターでもあります。
SessionStore	複数の要求にわたって ID を格納するオプションのコンテナー。 使用した場合、セッション識別子のみがクライアントに送信されます。 ID がきわめて大きいことによって生じる可能性のある問題を軽減することができます。
SlidingExpiration	SlidingExpiration は true に設定され、ミドルウェアに、有効期間の半分を過ぎた要求を処理する場合にいつでも、新しい有効期限で新しい Cookie を再発行するように指示します。
SystemClock	For testing purposes only. (継承元 AuthenticationOptions)
TicketDataFormat	TicketDataFormat は、Cookie 値に格納されている ID とその他のプロパティを保護または保護解除するために使用します。 指定されていない場合、IApplicationBuilder.Properties に含まれるデータ保護サービスを使用して、既定のデータ ハンドラーが作成されます。 既定のデータ保護サービスは、ASP.NET での実行時はマシン キーに基づき、別のプロセスでの実行時は DPAPI に基づきます。

明示的なインターフェイスの実装

IOptions<CookieAuthenticationOptions>.Value

CookieAuthenticationMiddleware の構成オプション。