CookieAuthenticationOptions.Cookie Property

Definition

Namespace:

Microsoft.AspNetCore.Authentication.Cookies

Assembly:

Microsoft.AspNetCore.Authentication.Cookies.dll

Package:

Microsoft.AspNetCore.Authentication.Cookies v2.0.0

Package:

Microsoft.AspNetCore.Authentication.Cookies v2.1.0

Package:

Microsoft.AspNetCore.Authentication.Cookies v2.2.0

Package:

Microsoft.AspNetCore.App.Ref v3.0.1

Package:

Microsoft.AspNetCore.App.Ref v3.1.10

Package:

Microsoft.AspNetCore.App.Ref v5.0.0

Package:

Microsoft.AspNetCore.App.Ref v6.0.6

Package:

Microsoft.AspNetCore.App.Ref v7.0.0-preview.5.22303.8

Determines the settings used to create the cookie.

SameSite defaults to Lax. HttpOnly defaults to true. SecurePolicy defaults to SameAsRequest.

public:
 property Microsoft::AspNetCore::Http::CookieBuilder ^ Cookie { Microsoft::AspNetCore::Http::CookieBuilder ^ get(); void set(Microsoft::AspNetCore::Http::CookieBuilder ^ value); };

public Microsoft.AspNetCore.Http.CookieBuilder Cookie { get; set; }

member this.Cookie : Microsoft.AspNetCore.Http.CookieBuilder with get, set

Public Property Cookie As CookieBuilder

Property Value

CookieBuilder

Remarks

The default value for cookie Name is ".AspNetCore.Cookies". This value should be changed if you change the name of the AuthenticationScheme, especially if your system uses the cookie authentication handler multiple times.

SameSite determines if the browser should allow the cookie to be attached to same-site or cross-site requests. The default is Lax, which means the cookie is only allowed to be attached to cross-site requests using safe HTTP methods and same-site requests.

HttpOnly determines if the browser should allow the cookie to be accessed by client-side javascript. The default is true, which means the cookie will only be passed to http requests and is not made available to script on the page.

Expiration is currently ignored. Use ExpireTimeSpan to control lifetime of cookie authentication.