View Source

Class SecuritySettings

Typed configuration options for security settings.

Inheritance
object
Namespace: Umbraco.Cms.Core.Configuration.Models
Assembly: Umbraco.Core.dll
Syntax
[UmbracoOptions("Umbraco:CMS:Security")]
public class SecuritySettings

Constructors

View Source

SecuritySettings()

Declaration
public SecuritySettings()

Properties

View Source

AllowConcurrentLogins

Gets or sets a value indicating whether to allow concurrent logins.

Declaration
public bool AllowConcurrentLogins { get; set; }
Property Value
Type Description
bool
View Source

AllowPasswordReset

Gets or sets a value indicating whether to allow user password reset.

Declaration
public bool AllowPasswordReset { get; set; }
Property Value
Type Description
bool
View Source

AllowedUserNameCharacters

Gets or sets the set of allowed characters for a username

Declaration
public string AllowedUserNameCharacters { get; set; }
Property Value
Type Description
string
View Source

AuthCookieDomain

Gets or sets a value for the authorization cookie domain.

Declaration
public string? AuthCookieDomain { get; set; }
Property Value
Type Description
string
View Source

AuthCookieName

Gets or sets a value for the authorization cookie name.

Declaration
public string AuthCookieName { get; set; }
Property Value
Type Description
string
View Source

AuthorizeCallbackErrorPathName

Gets or sets the path to use for authorization callback error. Will be appended to the BackOfficeHost.

Declaration
public string AuthorizeCallbackErrorPathName { get; set; }
Property Value
Type Description
string
View Source

AuthorizeCallbackLogoutPathName

Gets or sets the path to use for authorization callback logout. Will be appended to the BackOfficeHost.

Declaration
public string AuthorizeCallbackLogoutPathName { get; set; }
Property Value
Type Description
string
View Source

AuthorizeCallbackPathName

Gets or sets the path to use for authorization callback. Will be appended to the BackOfficeHost.

Declaration
public string AuthorizeCallbackPathName { get; set; }
Property Value
Type Description
string
View Source

BackOfficeHost

Gets or sets a value of the back-office host URI. Use this when running the back-office client and the Management API on different hosts. Leave empty when running both on the same host.

Declaration
public Uri? BackOfficeHost { get; set; }
Property Value
Type Description
Uri
View Source

HideDisabledUsersInBackOffice

Gets or sets a value indicating whether to hide disabled users in the back-office.

Declaration
public bool HideDisabledUsersInBackOffice { get; set; }
Property Value
Type Description
bool
View Source

KeepUserLoggedIn

Gets or sets a value indicating whether to keep the user logged in.

Declaration
public bool KeepUserLoggedIn { get; set; }
Property Value
Type Description
bool
View Source

MemberAllowConcurrentLogins

Gets or sets a value indicating whether to allow concurrent logins for members. When null (default), the value of AllowConcurrentLogins is used.

Declaration
public bool? MemberAllowConcurrentLogins { get; set; }
Property Value
Type Description
bool?
View Source

MemberBypassTwoFactorForExternalLogins

Gets or sets a value indicating whether to bypass the two factor requirement in Umbraco when using external login for members. Thereby rely on the External login and potential 2FA at that provider.

Declaration
public bool MemberBypassTwoFactorForExternalLogins { get; set; }
Property Value
Type Description
bool
View Source

MemberDefaultLockoutTimeInMinutes

Gets or sets a value for how long (in minutes) a member is locked out when a lockout occurs.

Declaration
public int MemberDefaultLockoutTimeInMinutes { get; set; }
Property Value
Type Description
int
View Source

MemberPassword

Declaration
public MemberPasswordConfigurationSettings MemberPassword { get; set; }
Property Value
Type Description
MemberPasswordConfigurationSettings
View Source

MemberRequireUniqueEmail

Gets or sets a value indicating whether the member's email address must be unique.

Declaration
public bool MemberRequireUniqueEmail { get; set; }
Property Value
Type Description
bool
View Source

PasswordResetEmailExpiry

Gets or sets the expiry time for password reset emails.

Declaration
public TimeSpan PasswordResetEmailExpiry { get; set; }
Property Value
Type Description
TimeSpan
View Source

UserAllowConcurrentLogins

Gets or sets a value indicating whether to allow concurrent logins for backoffice users. When null (default), the value of AllowConcurrentLogins is used.

Declaration
public bool? UserAllowConcurrentLogins { get; set; }
Property Value
Type Description
bool?
View Source

UserBypassTwoFactorForExternalLogins

Gets or sets a value indicating whether to bypass the two factor requirement in Umbraco when using external login for users. Thereby rely on the External login and potential 2FA at that provider.

Declaration
public bool UserBypassTwoFactorForExternalLogins { get; set; }
Property Value
Type Description
bool
View Source

UserDefaultFailedLoginDurationInMilliseconds

Gets or sets the default duration (in milliseconds) of failed login attempts.

Declaration
[Range(0, 9.223372036854776E+18)]
public long UserDefaultFailedLoginDurationInMilliseconds { get; set; }
Property Value
Type Description
long

The default duration (in milliseconds) of failed login attempts.
Remarks

The user login endpoint ensures that failed login attempts take at least as long as the average successful login. However, if no successful logins have occurred, this value is used as the default duration.

View Source

UserDefaultLockoutTimeInMinutes

Gets or sets a value for how long (in minutes) a user is locked out when a lockout occurs.

Declaration
public int UserDefaultLockoutTimeInMinutes { get; set; }
Property Value
Type Description
int
View Source

UserInviteEmailExpiry

Gets or sets the expiry time for user invite emails.

Declaration
public TimeSpan UserInviteEmailExpiry { get; set; }
Property Value
Type Description
TimeSpan
View Source

UserMinimumFailedLoginDurationInMilliseconds

Gets or sets the minimum duration (in milliseconds) of failed login attempts.

Declaration
[Range(0, 9.223372036854776E+18)]
public long UserMinimumFailedLoginDurationInMilliseconds { get; set; }
Property Value
Type Description
long

The minimum duration (in milliseconds) of failed login attempts.
View Source

UserPassword

Gets or sets the password configuration settings for users.

Declaration
public UserPasswordConfigurationSettings UserPassword { get; set; }
Property Value
Type Description
UserPasswordConfigurationSettings
Remarks

This property exists to enable IntelliSense/autocomplete in appsettings.json for the Umbraco:CMS:Security:UserPassword configuration section.

Do not use this property to read password configuration at runtime. Inject IOptions<UserPasswordConfigurationSettings> directly instead, as that is the canonical registration used by all consumers.

TODO (V18): Remove the standalone UserPasswordConfigurationSettings registration and consolidate all consumers to use this property.

View Source

UsernameIsEmail

Gets or sets a value indicating whether the user's email address is to be considered as their username.

Declaration
public bool UsernameIsEmail { get; set; }
Property Value
Type Description
bool

Methods

View Source

GetMemberAllowConcurrentLogins()

Gets the effective concurrent login setting for members.

Declaration
public bool GetMemberAllowConcurrentLogins()
Returns
Type Description
bool
View Source

GetUserAllowConcurrentLogins()

Gets the effective concurrent login setting for backoffice users.

Declaration
public bool GetUserAllowConcurrentLogins()
Returns
Type Description
bool