CookieAuthenticationOptions 類別

定義

命名空間:

Microsoft.AspNetCore.Authentication.Cookies

組件:

Microsoft.AspNetCore.Authentication.Cookies.dll

套件:

Microsoft.AspNetCore.App.Ref v8.0.0

來源:

CookieAuthenticationOptions.cs

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	處理 ForbidAsync 時，重新導向目標的處理常式會使用 AccessDeniedPath 屬性。
ClaimsIssuer	取得或設定應該用於任何已建立宣告的簽發者 (繼承來源 AuthenticationSchemeOptions)
Cookie	決定用來建立 Cookie 的設定。
CookieManager	用以從要求取得 Cookie 或在回應上設定 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	當處理 ChallengeAsync 時，重新導向目標的處理常式會使用 LoginPath 屬性。 目前新增至 LoginPath 的 URL，做為 ReturnUrlParameter 所命名的查詢字串參數。 一旦對 LoginPath 的要求授與新的 SignIn 身分識別，ReturnUrlParameter 值就會用來將瀏覽器重新導向回原始 URL。
LogoutPath	如果已提供 LogoutPath，處理常式就會根據 ReturnUrlParameter 重新導向該路徑的要求。
ReturnUrlParameter	ReturnUrlParameter 會決定在 Challenge 期間由處理常式附加的查詢字串參數名稱。 這也是查詢字串參數在要求抵達登入路徑或登出路徑時尋找的，以在執行動作之後傳回至原始 URL。
SessionStore	跨要求儲存識別的選擇性容器。 使用時，只會將工作階段識別碼傳送至用戶端。 這可用來減輕有大量識別時的潛在問題。
SlidingExpiration	SlidingExpiration 設定為 true，以指示處理常式在處理超過到期時間一半的要求時，以新的到期時間重新發出新的 Cookie。
TicketDataFormat	TicketDataFormat 用來保護且取消保護識別，以及其他儲存在 cookie 值中的屬性。 如果未提供，則會使用 DataProtectionProvider 建立一個 。
TimeProvider	用於測試。 (繼承來源 AuthenticationSchemeOptions)

方法

Validate()	檢查選項是否有效。 如果專案不正常，應該擲回例外狀況。 (繼承來源 AuthenticationSchemeOptions)
Validate(String)	檢查選項是否對特定配置有效 (繼承來源 AuthenticationSchemeOptions)