View Source

Class BackOfficeSignInManager

The sign in manager for back office users

Inheritance

System.Object

Microsoft.AspNetCore.Identity.SignInManager<BackOfficeIdentityUser>

UmbracoSignInManager<BackOfficeIdentityUser>

Namespace: Umbraco.Cms.Web.BackOffice.Security

Assembly: Umbraco.Web.BackOffice.dll

Syntax

public class BackOfficeSignInManager : UmbracoSignInManager<BackOfficeIdentityUser>, IBackOfficeSignInManager

Constructors

BackOfficeSignInManager(BackOfficeUserManager, IHttpContextAccessor, IBackOfficeExternalLoginProviders, IUserClaimsPrincipalFactory<BackOfficeIdentityUser>, IOptions<IdentityOptions>, IOptions<GlobalSettings>, ILogger<SignInManager<BackOfficeIdentityUser>>, IAuthenticationSchemeProvider, IUserConfirmation<BackOfficeIdentityUser>)

Declaration

public BackOfficeSignInManager(BackOfficeUserManager userManager, IHttpContextAccessor contextAccessor, IBackOfficeExternalLoginProviders externalLogins, IUserClaimsPrincipalFactory<BackOfficeIdentityUser> claimsFactory, IOptions<IdentityOptions> optionsAccessor, IOptions<GlobalSettings> globalSettings, ILogger<SignInManager<BackOfficeIdentityUser>> logger, IAuthenticationSchemeProvider schemes, IUserConfirmation<BackOfficeIdentityUser> confirmation)

Parameters

Type	Name	Description
BackOfficeUserManager	userManager
Microsoft.AspNetCore.Http.IHttpContextAccessor	contextAccessor
IBackOfficeExternalLoginProviders	externalLogins
Microsoft.AspNetCore.Identity.IUserClaimsPrincipalFactory<BackOfficeIdentityUser>	claimsFactory
Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Identity.IdentityOptions>	optionsAccessor
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Identity.SignInManager<BackOfficeIdentityUser>>	logger
Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider	schemes
Microsoft.AspNetCore.Identity.IUserConfirmation<BackOfficeIdentityUser>	confirmation

BackOfficeSignInManager(BackOfficeUserManager, IHttpContextAccessor, IBackOfficeExternalLoginProviders, IUserClaimsPrincipalFactory<BackOfficeIdentityUser>, IOptions<IdentityOptions>, IOptions<GlobalSettings>, ILogger<SignInManager<BackOfficeIdentityUser>>, IAuthenticationSchemeProvider, IUserConfirmation<BackOfficeIdentityUser>, IEventAggregator)

Declaration

public BackOfficeSignInManager(BackOfficeUserManager userManager, IHttpContextAccessor contextAccessor, IBackOfficeExternalLoginProviders externalLogins, IUserClaimsPrincipalFactory<BackOfficeIdentityUser> claimsFactory, IOptions<IdentityOptions> optionsAccessor, IOptions<GlobalSettings> globalSettings, ILogger<SignInManager<BackOfficeIdentityUser>> logger, IAuthenticationSchemeProvider schemes, IUserConfirmation<BackOfficeIdentityUser> confirmation, IEventAggregator eventAggregator)

Parameters

Type	Name	Description
BackOfficeUserManager	userManager
Microsoft.AspNetCore.Http.IHttpContextAccessor	contextAccessor
IBackOfficeExternalLoginProviders	externalLogins
Microsoft.AspNetCore.Identity.IUserClaimsPrincipalFactory<BackOfficeIdentityUser>	claimsFactory
Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Identity.IdentityOptions>	optionsAccessor
Microsoft.Extensions.Options.IOptions<GlobalSettings>	globalSettings
Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Identity.SignInManager<BackOfficeIdentityUser>>	logger
Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider	schemes
Microsoft.AspNetCore.Identity.IUserConfirmation<BackOfficeIdentityUser>	confirmation
IEventAggregator	eventAggregator

Properties

AuthenticationType

Declaration

protected override string AuthenticationType { get; }

Property Value

Type	Description
System.String

ExternalAuthenticationType

Declaration

protected override string ExternalAuthenticationType { get; }

Property Value

Type	Description
System.String

TwoFactorAuthenticationType

Declaration

protected override string TwoFactorAuthenticationType { get; }

Property Value

Type	Description
System.String

TwoFactorRememberMeAuthenticationType

Declaration

protected override string TwoFactorRememberMeAuthenticationType { get; }

Property Value

Type	Description
System.String

Methods

ConfigureExternalAuthenticationProperties(String, String, String)

Configures the redirect URL and user identifier for the specified external login provider.

Declaration

public override AuthenticationProperties ConfigureExternalAuthenticationProperties(string provider, string redirectUrl, string userId = null)

Parameters

Type	Name	Description
System.String	provider	The provider to configure.
System.String	redirectUrl	The external login URL users should be redirected to during the login flow.
System.String	userId	The current user's identifier, which will be used to provide CSRF protection.

Returns

Type	Description
Microsoft.AspNetCore.Authentication.AuthenticationProperties	A configured Microsoft.AspNetCore.Authentication.AuthenticationProperties.

ExternalLoginSignInAsync(ExternalLoginInfo, Boolean, Boolean)

Custom ExternalLoginSignInAsync overload for handling external sign in with auto-linking

Declaration

public async Task<SignInResult> ExternalLoginSignInAsync(ExternalLoginInfo loginInfo, bool isPersistent, bool bypassTwoFactor = false)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Identity.ExternalLoginInfo	loginInfo
System.Boolean	isPersistent
System.Boolean	bypassTwoFactor

Returns

Type	Description
Task<Microsoft.AspNetCore.Identity.SignInResult>

GetExternalAuthenticationSchemesAsync()

Declaration

public override Task<IEnumerable<AuthenticationScheme>> GetExternalAuthenticationSchemesAsync()

Returns

Type	Description
Task<IEnumerable<Microsoft.AspNetCore.Authentication.AuthenticationScheme>>

HandleSignIn(Nullable<BackOfficeIdentityUser>, String, SignInResult)

Overridden to deal with events/notificiations

Declaration

protected override async Task<SignInResult> HandleSignIn(BackOfficeIdentityUser? user, string username, SignInResult result)

Parameters

Type	Name	Description
System.Nullable<BackOfficeIdentityUser>	user
System.String	username
Microsoft.AspNetCore.Identity.SignInResult	result

Returns

Type	Description
Task<Microsoft.AspNetCore.Identity.SignInResult>

NotifyRequiresTwoFactor(BackOfficeIdentityUser)

Declaration

protected void NotifyRequiresTwoFactor(BackOfficeIdentityUser user)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user

SignInOrTwoFactorAsync(BackOfficeIdentityUser, Boolean, String, Boolean)

Declaration

protected override async Task<SignInResult> SignInOrTwoFactorAsync(BackOfficeIdentityUser user, bool isPersistent, string loginProvider = null, bool bypassTwoFactor = false)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user
System.Boolean	isPersistent
System.String	loginProvider
System.Boolean	bypassTwoFactor

Returns

Type	Description
Task<Microsoft.AspNetCore.Identity.SignInResult>