View Source

Class BackOfficeExternalLoginProviders

Inheritance

object

Namespace: Umbraco.Cms.Api.Management.Security

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class BackOfficeExternalLoginProviders : IBackOfficeExternalLoginProviders, ILocalLoginSettingProvider

Constructors

BackOfficeExternalLoginProviders(IEnumerable<BackOfficeExternalLoginProvider>, IAuthenticationSchemeProvider, IKeyValueService, IExternalLoginWithKeyService, ILogger<BackOfficeExternalLoginProviders>)

Initializes a new instance of the BackOfficeExternalLoginProviders class.

Declaration

public BackOfficeExternalLoginProviders(IEnumerable<BackOfficeExternalLoginProvider> externalLogins, IAuthenticationSchemeProvider authenticationSchemeProvider, IKeyValueService keyValueService, IExternalLoginWithKeyService externalLoginWithKeyService, ILogger<BackOfficeExternalLoginProviders> logger)

Parameters

Type	Name	Description
IEnumerable<BackOfficeExternalLoginProvider>	externalLogins	A collection of available external login providers for the backoffice.
IAuthenticationSchemeProvider	authenticationSchemeProvider	Provides access to authentication schemes used for external logins.
IKeyValueService	keyValueService	Service for storing and retrieving key-value pairs related to authentication.
IExternalLoginWithKeyService	externalLoginWithKeyService	Service for handling external logins that require a key.
ILogger<BackOfficeExternalLoginProviders>	logger	The logger used for logging information and errors related to external login providers.

Methods

GetAsync(string)

Get the BackOfficeExternalLoginProvider for the specified scheme

Declaration

public Task<BackOfficeExternaLoginProviderScheme?> GetAsync(string authenticationType)

Parameters

Type	Name	Description
string	authenticationType	The authentication scheme name.

Returns

Type	Description
Task<BackOfficeExternaLoginProviderScheme>	The external login provider scheme, or null if not found.

GetBackOfficeProvidersAsync()

Get all registered BackOfficeExternalLoginProvider

Declaration

public Task<IEnumerable<BackOfficeExternaLoginProviderScheme>> GetBackOfficeProvidersAsync()

Returns

Type	Description
Task<IEnumerable<BackOfficeExternaLoginProviderScheme>>	All registered back office external login provider schemes.

HasDenyLocalLogin()

Returns true if there is any external provider that has the Deny Local Login option configured

Declaration

public bool HasDenyLocalLogin()

Returns

Type	Description
bool	True if any provider has deny local login configured.

InvalidateSessionsIfExternalLoginProvidersChanged()

Used during startup to see if the configured external login providers is different from the persisted information. If they are different, this will invalidate backoffice sessions and clear external logins for removed providers if the external login provider setup has changed.

Declaration

public void InvalidateSessionsIfExternalLoginProvidersChanged()