View Source

Class BackOfficeTokenCookieSettings

Typed configuration options for back-office token cookie settings.

Inheritance

object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

[UmbracoOptions("Umbraco:CMS:Security:BackOfficeTokenCookie")]
[Obsolete("This will be replaced with a different authentication scheme. Scheduled for removal in Umbraco 18.")]
public class BackOfficeTokenCookieSettings

Constructors

BackOfficeTokenCookieSettings()

Declaration

public BackOfficeTokenCookieSettings()

Properties

SameSite

Gets or sets a value indicating whether the cookie SameSite configuration.

Declaration

public string SameSite { get; set; }

Property Value

Type	Description
string

Remarks

Valid values are "Unspecified", "None", "Lax" and "Strict" (default).

SiteName

Gets or sets the site-specific suffix used to create a unique cookie name for the back-office token cookies. Use this to avoid conflicts when running multiple Umbraco sites on the same domain. The value of SiteName is appended to the base cookie name verbatim; if you want a separator (such as a hyphen or underscore), include it in the value. For example, if the site name is "-siteA", the cookie names will be "__Host-umbAccessToken-siteA", "__Host-umbRefreshToken-siteA", and "umbPkceCode-siteA". If the site name is empty, the cookie names will be "__Host-umbAccessToken", "__Host-umbRefreshToken", and "umbPkceCode".

Declaration

public string SiteName { get; set; }

Property Value

Type	Description
string

Examples

If SiteName is set to "-siteA", the resulting cookie names are "__Host-umbAccessToken-siteA", "__Host-umbRefreshToken-siteA", and "umbPkceCode-siteA".