View Source

Class BackOfficeAuthenticationBuilder

Custom Microsoft.AspNetCore.Authentication.AuthenticationBuilder used to associate external logins with umbraco external login options

Inheritance

object

AuthenticationBuilder

Namespace: Umbraco.Cms.Api.Management.Security

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class BackOfficeAuthenticationBuilder : AuthenticationBuilder

Constructors

BackOfficeAuthenticationBuilder(IServiceCollection, Action<BackOfficeExternalLoginProviderOptions>?)

Initializes a new instance of the BackOfficeAuthenticationBuilder class.

Declaration

public BackOfficeAuthenticationBuilder(IServiceCollection services, Action<BackOfficeExternalLoginProviderOptions>? loginProviderOptions = null)

Parameters

Type	Name	Description
IServiceCollection	services	The Microsoft.Extensions.DependencyInjection.IServiceCollection to which authentication services will be added.
Action<BackOfficeExternalLoginProviderOptions>	loginProviderOptions	An optional action to configure external login provider options.

Methods

AddRemoteScheme<TOptions, THandler>(string, string?, Action<TOptions>?)

Overridden to track the final authenticationScheme being registered for the external login

Declaration

public override AuthenticationBuilder AddRemoteScheme<TOptions, THandler>(string authenticationScheme, string? displayName, Action<TOptions>? configureOptions) where TOptions : RemoteAuthenticationOptions, new() where THandler : RemoteAuthenticationHandler<TOptions>

Parameters

Type	Name	Description
string	authenticationScheme	The authentication scheme name.
string	displayName	The display name for the scheme.
Action<TOptions>	configureOptions	Optional configuration for the scheme options.

Returns

Type	Description
AuthenticationBuilder	The authentication builder for chaining.

Type Parameters

Name	Description
TOptions
THandler

SchemeForBackOffice(string)

Returns the specified authentication scheme prefixed with the back office external authentication type prefix.

Declaration

public static string? SchemeForBackOffice(string scheme)

Parameters

Type	Name	Description
string	scheme	The authentication scheme to prefix.

Returns

Type	Description
string	The prefixed scheme, or null if scheme is null.