Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

AntiforgeryOptions.Cookie Property

Definition

Namespace:
Microsoft.AspNetCore.Antiforgery
Assembly:
Microsoft.AspNetCore.Antiforgery.dll
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.Antiforgery v2.0.0
Package:
Microsoft.AspNetCore.Antiforgery v2.1.0
Package:
Microsoft.AspNetCore.Antiforgery 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.36
Package:
Microsoft.AspNetCore.App.Ref v7.0.5
Package:
Microsoft.AspNetCore.App.Ref v8.0.19
Package:
Microsoft.AspNetCore.App.Ref v9.0.8
Source:
AntiforgeryOptions.cs
Source:
AntiforgeryOptions.cs
Source:
AntiforgeryOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Determines the settings used to create the antiforgery cookies.

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

Remarks

If an explicit Name is not provided, the system will automatically generate a unique name that begins with DefaultCookiePrefix.

  • SameSite defaults to Strict.
  • HttpOnly defaults to true.
  • IsEssential defaults to true. The cookie used by the antiforgery system is part of a security system that is necessary when using cookie-based authentication. It should be considered required for the application to function.
  • SecurePolicy defaults to None.

Applies to

Feedback

Was this page helpful?