View Source

Class MemberSignInManager

The sign in manager for members

Inheritance

System.Object

Microsoft.AspNetCore.Identity.SignInManager<MemberIdentityUser>

UmbracoSignInManager<MemberIdentityUser>

Namespace: Umbraco.Cms.Web.Common.Security

Assembly: Umbraco.Web.Common.dll

Syntax

public class MemberSignInManager : UmbracoSignInManager<MemberIdentityUser>, IMemberSignInManager

Constructors

MemberSignInManager(UserManager<MemberIdentityUser>, IHttpContextAccessor, IUserClaimsPrincipalFactory<MemberIdentityUser>, IOptions<IdentityOptions>, ILogger<SignInManager<MemberIdentityUser>>, IAuthenticationSchemeProvider, IUserConfirmation<MemberIdentityUser>, IMemberExternalLoginProviders, IEventAggregator, IOptions<SecuritySettings>)

Declaration

public MemberSignInManager(UserManager<MemberIdentityUser> memberManager, IHttpContextAccessor contextAccessor, IUserClaimsPrincipalFactory<MemberIdentityUser> claimsFactory, IOptions<IdentityOptions> optionsAccessor, ILogger<SignInManager<MemberIdentityUser>> logger, IAuthenticationSchemeProvider schemes, IUserConfirmation<MemberIdentityUser> confirmation, IMemberExternalLoginProviders memberExternalLoginProviders, IEventAggregator eventAggregator, IOptions<SecuritySettings> securitySettings)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Identity.UserManager<MemberIdentityUser>	memberManager
Microsoft.AspNetCore.Http.IHttpContextAccessor	contextAccessor
Microsoft.AspNetCore.Identity.IUserClaimsPrincipalFactory<MemberIdentityUser>	claimsFactory
Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Identity.IdentityOptions>	optionsAccessor
Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Identity.SignInManager<MemberIdentityUser>>	logger
Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider	schemes
Microsoft.AspNetCore.Identity.IUserConfirmation<MemberIdentityUser>	confirmation
IMemberExternalLoginProviders	memberExternalLoginProviders
IEventAggregator	eventAggregator
Microsoft.Extensions.Options.IOptions<SecuritySettings>	securitySettings

MemberSignInManager(UserManager<MemberIdentityUser>, IHttpContextAccessor, IUserClaimsPrincipalFactory<MemberIdentityUser>, IOptions<IdentityOptions>, ILogger<SignInManager<MemberIdentityUser>>, IAuthenticationSchemeProvider, IUserConfirmation<MemberIdentityUser>, IMemberExternalLoginProviders, IEventAggregator, IOptions<SecuritySettings>, IRequestCache)

Declaration

public MemberSignInManager(UserManager<MemberIdentityUser> memberManager, IHttpContextAccessor contextAccessor, IUserClaimsPrincipalFactory<MemberIdentityUser> claimsFactory, IOptions<IdentityOptions> optionsAccessor, ILogger<SignInManager<MemberIdentityUser>> logger, IAuthenticationSchemeProvider schemes, IUserConfirmation<MemberIdentityUser> confirmation, IMemberExternalLoginProviders memberExternalLoginProviders, IEventAggregator eventAggregator, IOptions<SecuritySettings> securitySettings, IRequestCache requestCache)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Identity.UserManager<MemberIdentityUser>	memberManager
Microsoft.AspNetCore.Http.IHttpContextAccessor	contextAccessor
Microsoft.AspNetCore.Identity.IUserClaimsPrincipalFactory<MemberIdentityUser>	claimsFactory
Microsoft.Extensions.Options.IOptions<Microsoft.AspNetCore.Identity.IdentityOptions>	optionsAccessor
Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Identity.SignInManager<MemberIdentityUser>>	logger
Microsoft.AspNetCore.Authentication.IAuthenticationSchemeProvider	schemes
Microsoft.AspNetCore.Identity.IUserConfirmation<MemberIdentityUser>	confirmation
IMemberExternalLoginProviders	memberExternalLoginProviders
IEventAggregator	eventAggregator
Microsoft.Extensions.Options.IOptions<SecuritySettings>	securitySettings
IRequestCache	requestCache

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)

Declaration

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

Parameters

Type	Name	Description
System.String	provider
System.String	redirectUrl
System.String	userId

Returns

Type	Description
Microsoft.AspNetCore.Authentication.AuthenticationProperties

ExternalLoginSignInAsync(ExternalLoginInfo, Boolean, Boolean)

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

Declaration

public virtual 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>

GetExternalLoginInfoAsync(String)

Declaration

public override async Task<ExternalLoginInfo> GetExternalLoginInfoAsync(string expectedXsrf = null)

Parameters

Type	Name	Description
System.String	expectedXsrf

Returns

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

HandleFailedLinkingUser(MemberIdentityUser, IdentityResult)

Declaration

protected Task<MemberSignInManager.AutoLinkSignInResult> HandleFailedLinkingUser(MemberIdentityUser autoLinkUser, IdentityResult linkResult)

Parameters

Type	Name	Description
MemberIdentityUser	autoLinkUser
Microsoft.AspNetCore.Identity.IdentityResult	linkResult

Returns

Type	Description
Task<MemberSignInManager.AutoLinkSignInResult>

NotifyRequiresTwoFactor(MemberIdentityUser)

Declaration

protected void NotifyRequiresTwoFactor(MemberIdentityUser user)

Parameters

Type	Name	Description
MemberIdentityUser	user

SignInOrTwoFactorAsync(MemberIdentityUser, Boolean, String, Boolean)

Declaration

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

Parameters

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

Returns

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