Note

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

Access to this page requires authorization. You can try .

CookiePolicyOptions Class

Definition

Namespace:
Microsoft.AspNetCore.Builder
Assembly:
Microsoft.AspNetCore.CookiePolicy.dll
Package:
Microsoft.AspNetCore.CookiePolicy v1.0.0
Package:
Microsoft.AspNetCore.CookiePolicy v1.1.0
Package:
Microsoft.AspNetCore.App.Ref v10.0.0
Package:
Microsoft.AspNetCore.App.Ref v11.0.0-preview.4.26230.115
Package:
Microsoft.AspNetCore.CookiePolicy v2.0.0
Package:
Microsoft.AspNetCore.CookiePolicy v2.1.0
Package:
Microsoft.AspNetCore.CookiePolicy 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:
CookiePolicyOptions.cs
Source:
CookiePolicyOptions.cs
Source:
CookiePolicyOptions.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.

Provides programmatic configuration for the CookiePolicyMiddleware.

public ref class CookiePolicyOptions
public class CookiePolicyOptions
type CookiePolicyOptions = class
Public Class CookiePolicyOptions
Inheritance
CookiePolicyOptions

Constructors

Name Description
CookiePolicyOptions()

Properties

Name Description
CheckConsentNeeded

Checks if consent policies should be evaluated on this request. The default is false.
ConsentCookie

Gets or sets the CookieBuilder that is used to track if the user consented to the cookie use policy.
ConsentCookieValue

Gets or sets the value for the cookie used to track if the user consented to the cookie use policy.
HttpOnly

Affects whether cookies must be HttpOnly.
MinimumSameSitePolicy

Affects the cookie's same site attribute.
OnAppendCookie

Called when a cookie is appended.
OnDeleteCookie

Called when a cookie is deleted.
Secure

Affects whether cookies must be Secure.

Applies to

Feedback

Was this page helpful?