View Source

Class Constants.Security

Security-related constants including user identifiers, authentication types, and claim types.

Inheritance

object

Namespace: Umbraco.Cms.Core

Assembly: Umbraco.Core.dll

Syntax

public static class Constants.Security

Fields

AdminGroupAlias

The alias of the admin user group.

Declaration

public const string AdminGroupAlias = "admin"

Field Value

Type	Description
string

AdminGroupKey

The key of the admin group

Declaration

public static readonly Guid AdminGroupKey

Field Value

Type	Description
Guid

AllowedApplicationsClaimType

The claim type for the user's allowed applications.

Declaration

[Obsolete("Please use IUser.AllowedSections instead. Scheduled for removal in Umbraco 18.")]
public const string AllowedApplicationsClaimType = "http://umbraco.org/2015/02/identity/claims/backoffice/allowedapp"

Field Value

Type	Description
string

AspNetCoreV2PasswordHashAlgorithmName

The algorithm name for ASP.NET Core v2 PBKDF2 password hashing.

Declaration

public const string AspNetCoreV2PasswordHashAlgorithmName = "PBKDF2.ASPNETCORE.V2"

Field Value

Type	Description
string

AspNetCoreV3PasswordHashAlgorithmName

The algorithm name for ASP.NET Core v3 PBKDF2 password hashing.

Declaration

public const string AspNetCoreV3PasswordHashAlgorithmName = "PBKDF2.ASPNETCORE.V3"

Field Value

Type	Description
string

AspNetUmbraco4PasswordHashAlgorithmName

The algorithm name for Umbraco 4 HMACSHA1 password hashing.

Declaration

public const string AspNetUmbraco4PasswordHashAlgorithmName = "HMACSHA1"

Field Value

Type	Description
string

AspNetUmbraco8PasswordHashAlgorithmName

The algorithm name for Umbraco 8 HMACSHA256 password hashing.

Declaration

public const string AspNetUmbraco8PasswordHashAlgorithmName = "HMACSHA256"

Field Value

Type	Description
string

BackOfficeAuthenticationType

The authentication type for backoffice authentication.

Declaration

public const string BackOfficeAuthenticationType = "UmbracoBackOffice"

Field Value

Type	Description
string

BackOfficeExposedAuthenticationType

Authentication type and scheme used for backoffice users when it is exposed out of the backoffice context via a cookie.

Declaration

public const string BackOfficeExposedAuthenticationType = "UmbracoBackOfficeExposed"

Field Value

Type	Description
string

BackOfficeExposedCookieName

Represents the name of the authentication cookie used to expose the backoffice authentication token outside the backoffice context.

Declaration

public const string BackOfficeExposedCookieName = "UMB_UCONTEXT_EXPOSED"

Field Value

Type	Description
string

BackOfficeExposedCookieNamePostfix

Represents the postfix for the authentication cookie used to expose the backoffice authentication token outside the backoffice context.

Declaration

public const string BackOfficeExposedCookieNamePostfix = "_EXPOSED"

Field Value

Type	Description
string

BackOfficeExternalAuthenticationType

The authentication type for backoffice external login providers.

Declaration

public const string BackOfficeExternalAuthenticationType = "UmbracoExternalCookie"

Field Value

Type	Description
string

BackOfficeExternalAuthenticationTypePrefix

The prefix used for external identity providers for their authentication type

Declaration

public const string BackOfficeExternalAuthenticationTypePrefix = "Umbraco."

Field Value

Type	Description
string

Remarks

By default we don't want to interfere with front-end external providers and their default setup, for back office the providers need to be setup differently and each auth type for the back office will be prefixed with this value

BackOfficeExternalCookieName

The cookie name for backoffice external login authentication.

Declaration

public const string BackOfficeExternalCookieName = "UMB_EXTLOGIN"

Field Value

Type	Description
string

BackOfficeTokenAuthenticationType

The authentication type for backoffice token-based authentication.

Declaration

public const string BackOfficeTokenAuthenticationType = "UmbracoBackOfficeToken"

Field Value

Type	Description
string

BackOfficeTwoFactorAuthenticationType

The authentication type for backoffice two-factor authentication.

Declaration

public const string BackOfficeTwoFactorAuthenticationType = "UmbracoTwoFactorCookie"

Field Value

Type	Description
string

BackOfficeTwoFactorRememberMeAuthenticationType

The authentication type for backoffice two-factor "remember me" functionality.

Declaration

public const string BackOfficeTwoFactorRememberMeAuthenticationType = "UmbracoTwoFactorRememberMeCookie"

Field Value

Type	Description
string

DefaultMemberTypeAlias

The default member type alias used when no specific member type is specified.

Declaration

public const string DefaultMemberTypeAlias = "Member"

Field Value

Type	Description
string

EditorGroupKey

The key of the editor group

Declaration

public static readonly Guid EditorGroupKey

Field Value

Type	Description
Guid

EmptyPasswordPrefix

The prefix used to identify empty password placeholders.

Declaration

public const string EmptyPasswordPrefix = "___UIDEMPTYPWORD__"

Field Value

Type	Description
string

MemberExternalAuthenticationTypePrefix

The prefix used for member external authentication types.

Declaration

public const string MemberExternalAuthenticationTypePrefix = "UmbracoMembers."

Field Value

Type	Description
string

OpenIdDictSubClaimType

The claim type for the mandatory OpenIdDict sub claim

Declaration

public const string OpenIdDictSubClaimType = "sub"

Field Value

Type	Description
string

SecurityStampClaimType

The claim type for the ASP.NET Identity security stamp

Declaration

public const string SecurityStampClaimType = "AspNet.Identity.SecurityStamp"

Field Value

Type	Description
string

SensitiveDataGroupKey

The key of the sensitive data group

Declaration

public static readonly Guid SensitiveDataGroupKey

Field Value

Type	Description
Guid

SessionIdClaimType

The claim type for the backoffice session ID.

Declaration

public const string SessionIdClaimType = "http://umbraco.org/2015/02/identity/claims/backoffice/sessionid"

Field Value

Type	Description
string

StartContentNodeIdClaimType

The claim type for the user's start content node ID.

Declaration

[Obsolete("Please use the UserExtensions class to access user start node info. Scheduled for removal in Umbraco 18.")]
public const string StartContentNodeIdClaimType = "http://umbraco.org/2015/02/identity/claims/backoffice/startcontentnode"

Field Value

Type	Description
string

StartMediaNodeIdClaimType

The claim type for the user's start media node ID.

Declaration

[Obsolete("Please use the UserExtensions class to access user start node info. Scheduled for removal in Umbraco 18.")]
public const string StartMediaNodeIdClaimType = "http://umbraco.org/2015/02/identity/claims/backoffice/startmedianode"

Field Value

Type	Description
string

SuperUserId

Gets the identifier of the 'super' user.

Declaration

[Obsolete("Use SuperUserKey instead. Scheduled for removal in Umbraco 18.")]
public const int SuperUserId = -1

Field Value

Type	Description
int

SuperUserIdAsString

Gets the identifier of the 'super' user as a string.

Declaration

[Obsolete("Use SuperUserKey instead. Scheduled for removal in Umbraco 18.")]
public const string SuperUserIdAsString = "-1"

Field Value

Type	Description
string

SuperUserKey

Gets the unique key of the 'super' user.

Declaration

public static readonly Guid SuperUserKey

Field Value

Type	Description
Guid

TicketExpiresClaimType

The claim type for the authentication ticket expiration time.

Declaration

public const string TicketExpiresClaimType = "http://umbraco.org/2020/06/identity/claims/backoffice/ticketexpires"

Field Value

Type	Description
string

TranslatorGroupKey

The key of the translator group

Declaration

public static readonly Guid TranslatorGroupKey

Field Value

Type	Description
Guid

UnknownPasswordConfigJson

The JSON configuration string for unknown password hash algorithms.

Declaration

public const string UnknownPasswordConfigJson = "{\"hashAlgorithm\":\"Unknown\"}"

Field Value

Type	Description
string

UnknownUserId

The id for the 'unknown' user.

Declaration

public const int UnknownUserId = 0

Field Value

Type	Description
int

Remarks

This is a user row that exists in the DB only for referential integrity but the user is never returned from any of the services

UnknownUserName

The name of the 'unknown' user.

Declaration

public const string UnknownUserName = "SYSTEM"

Field Value

Type	Description
string

WriterGroupKey

The key of the writer group

Declaration

public static readonly Guid WriterGroupKey

Field Value

Type	Description
Guid