Class SecuritySettings

Typed configuration options for security settings.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

public class 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
System.Boolean

View Source

AllowedUserNameCharacters

Gets or sets the set of allowed characters for a username

Declaration

public string AllowedUserNameCharacters { get; set; }

Property Value

Type	Description
System.String

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
System.Boolean

View Source

AuthCookieDomain

Gets or sets a value for the authorization cookie domain.

Declaration

public string AuthCookieDomain { get; set; }

Property Value

Type	Description
System.String

View Source

AuthCookieName

Gets or sets a value for the authorization cookie name.

Declaration

public string AuthCookieName { get; set; }

Property Value

Type	Description
System.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
System.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
System.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
System.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
System.Nullable<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
System.Boolean

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
System.Boolean

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
System.Boolean

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
System.Int32

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
System.Boolean

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
System.Boolean

View Source

UserDefaultFailedLoginDurationInMilliseconds

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

Declaration

[Range(0, 9.2233720368547758E+18)]
public long UserDefaultFailedLoginDurationInMilliseconds { get; set; }

Property Value

Type	Description
System.Int64	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
System.Int32

View Source

UserMinimumFailedLoginDurationInMilliseconds

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

Declaration

[Range(0, 9.2233720368547758E+18)]
public long UserMinimumFailedLoginDurationInMilliseconds { get; set; }

Property Value

Type	Description
System.Int64	The minimum duration (in milliseconds) of failed login attempts.

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
System.Boolean