View Source

Class BasicAuthSettings

Typed configuration options for basic authentication settings.

Inheritance

object

Namespace: Umbraco.Cms.Core.Configuration.Models

Assembly: Umbraco.Core.dll

Syntax

[UmbracoOptions("Umbraco:CMS:BasicAuth")]
public class BasicAuthSettings

Constructors

BasicAuthSettings()

Declaration

public BasicAuthSettings()

Properties

AllowedIPs

Gets or sets the collection of allowed IP addresses that bypass basic authentication.

Declaration

public ISet<string> AllowedIPs { get; set; }

Property Value

Type	Description
ISet<string>

Enabled

Gets or sets a value indicating whether Basic Auth Middleware is enabled.

Declaration

public bool Enabled { get; set; }

Property Value

Type	Description
bool

LoginViewPath

Gets or sets a value for the path to the login view.

Declaration

public string LoginViewPath { get; set; }

Property Value

Type	Description
string

RedirectToLoginPage

Gets or sets a value indicating whether to redirect to the login page instead of showing basic auth prompt.

Declaration

public bool RedirectToLoginPage { get; set; }

Property Value

Type	Description
bool

SharedSecret

Gets or sets the shared secret configuration for header-based authentication.

Declaration

public SharedSecret SharedSecret { get; set; }

Property Value

Type	Description
SharedSecret

TwoFactorViewPath

Gets or sets a value for the path to the two-factor view.

Declaration

public string TwoFactorViewPath { get; set; }

Property Value

Type	Description
string