View Source

Interface IBasicAuthService

Provides services for basic authentication operations.

Namespace: Umbraco.Cms.Core.Services

Assembly: Umbraco.Core.dll

Syntax

public interface IBasicAuthService

Methods

HasCorrectSharedSecret(IDictionary<string, StringValues>)

Checks if the request headers contain the correct shared secret.

Declaration

bool HasCorrectSharedSecret(IDictionary<string, StringValues> headers)

Parameters

Type	Name	Description
IDictionary<string, StringValues>	headers	The HTTP request headers.

Returns

Type	Description
bool	true if the headers contain the correct shared secret; otherwise, false.

IsBasicAuthEnabled()

Gets a value indicating whether basic authentication is enabled.

Declaration

bool IsBasicAuthEnabled()

Returns

Type	Description
bool	true if basic authentication is enabled; otherwise, false.

IsIpAllowListed(IPAddress)

Checks if the specified IP address is in the allow list.

Declaration

bool IsIpAllowListed(IPAddress clientIpAddress)

Parameters

Type	Name	Description
IPAddress	clientIpAddress	The client IP address to check.

Returns

Type	Description
bool	true if the IP address is allow-listed; otherwise, false.

IsRedirectToLoginPageEnabled()

Gets a value indicating whether redirect to login page is enabled for unauthenticated requests.

Declaration

bool IsRedirectToLoginPageEnabled()

Returns

Type	Description
bool	true if redirect to login page is enabled; otherwise, false.