View Source

Class BackOfficeUserManager

Inheritance

System.Object

UmbracoUserManager<BackOfficeIdentityUser, UserPasswordConfigurationSettings>

Namespace: Umbraco.Cms.Web.Common.Security

Assembly: Umbraco.Web.Common.dll

Syntax

public class BackOfficeUserManager : UmbracoUserManager<BackOfficeIdentityUser, UserPasswordConfigurationSettings>, IBackOfficeUserManager, IUmbracoUserManager<BackOfficeIdentityUser>

Constructors

BackOfficeUserManager(IIpResolver, IUserStore<BackOfficeIdentityUser>, IOptions<BackOfficeIdentityOptions>, IPasswordHasher<BackOfficeIdentityUser>, IEnumerable<IUserValidator<BackOfficeIdentityUser>>, IEnumerable<IPasswordValidator<BackOfficeIdentityUser>>, BackOfficeErrorDescriber, IServiceProvider, IHttpContextAccessor, ILogger<UserManager<BackOfficeIdentityUser>>, IOptions<UserPasswordConfigurationSettings>, IEventAggregator, IBackOfficeUserPasswordChecker)

Declaration

public BackOfficeUserManager(IIpResolver ipResolver, IUserStore<BackOfficeIdentityUser> store, IOptions<BackOfficeIdentityOptions> optionsAccessor, IPasswordHasher<BackOfficeIdentityUser> passwordHasher, IEnumerable<IUserValidator<BackOfficeIdentityUser>> userValidators, IEnumerable<IPasswordValidator<BackOfficeIdentityUser>> passwordValidators, BackOfficeErrorDescriber errors, IServiceProvider services, IHttpContextAccessor httpContextAccessor, ILogger<UserManager<BackOfficeIdentityUser>> logger, IOptions<UserPasswordConfigurationSettings> passwordConfiguration, IEventAggregator eventAggregator, IBackOfficeUserPasswordChecker backOfficeUserPasswordChecker)

Parameters

Type	Name	Description
IIpResolver	ipResolver
Microsoft.AspNetCore.Identity.IUserStore<BackOfficeIdentityUser>	store
Microsoft.Extensions.Options.IOptions<BackOfficeIdentityOptions>	optionsAccessor
Microsoft.AspNetCore.Identity.IPasswordHasher<BackOfficeIdentityUser>	passwordHasher
System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Identity.IUserValidator<BackOfficeIdentityUser>>	userValidators
System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Identity.IPasswordValidator<BackOfficeIdentityUser>>	passwordValidators
BackOfficeErrorDescriber	errors
System.IServiceProvider	services
Microsoft.AspNetCore.Http.IHttpContextAccessor	httpContextAccessor
Microsoft.Extensions.Logging.ILogger<Microsoft.AspNetCore.Identity.UserManager<BackOfficeIdentityUser>>	logger
Microsoft.Extensions.Options.IOptions<UserPasswordConfigurationSettings>	passwordConfiguration
IEventAggregator	eventAggregator
IBackOfficeUserPasswordChecker	backOfficeUserPasswordChecker

Methods

AccessFailedAsync(BackOfficeIdentityUser)

Declaration

public override async Task<IdentityResult> AccessFailedAsync(BackOfficeIdentityUser user)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.IdentityResult>

ChangePasswordAsync(BackOfficeIdentityUser, String, String)

Declaration

public override async Task<IdentityResult> ChangePasswordAsync(BackOfficeIdentityUser user, string currentPassword, string newPassword)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user
System.String	currentPassword
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.IdentityResult>

ChangePasswordWithResetAsync(String, String, String)

Declaration

public override async Task<IdentityResult> ChangePasswordWithResetAsync(string userId, string token, string newPassword)

Parameters

Type	Name	Description
System.String	userId
System.String	token
System.String	newPassword

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.IdentityResult>

IsLockedOutAsync(BackOfficeIdentityUser)

Override to check the user approval value as well as the user lock out date, by default this only checks the user's locked out date

Declaration

public override async Task<bool> IsLockedOutAsync(BackOfficeIdentityUser user)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user	The user

Returns

Type	Description
System.Threading.Tasks.Task<System.Boolean>	True if the user is locked out, else false

Remarks

In the ASP.NET Identity world, there is only one value for being locked out, in Umbraco we have 2 so when checking this for Umbraco we need to check both values

NotifyAccountLocked(IPrincipal, String)

Declaration

public void NotifyAccountLocked(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyAccountUnlocked(IPrincipal, String)

Declaration

public void NotifyAccountUnlocked(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyForgotPasswordChanged(IPrincipal, String)

Declaration

public void NotifyForgotPasswordChanged(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyForgotPasswordRequested(IPrincipal, String)

Declaration

public void NotifyForgotPasswordRequested(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyLoginFailed(IPrincipal, String)

Declaration

public void NotifyLoginFailed(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyLoginRequiresVerification(IPrincipal, String)

Declaration

public void NotifyLoginRequiresVerification(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyLoginSuccess(IPrincipal, String)

Declaration

public void NotifyLoginSuccess(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyLogoutSuccess(IPrincipal, String)

Declaration

public SignOutSuccessResult NotifyLogoutSuccess(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

Returns

Type	Description
SignOutSuccessResult

NotifyPasswordChanged(IPrincipal, String)

Declaration

public void NotifyPasswordChanged(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyPasswordReset(IPrincipal, String)

Declaration

public void NotifyPasswordReset(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

NotifyResetAccessFailedCount(IPrincipal, String)

Declaration

public void NotifyResetAccessFailedCount(IPrincipal currentUser, string userId)

Parameters

Type	Name	Description
System.Security.Principal.IPrincipal	currentUser
System.String	userId

ResetAccessFailedCountAsync(BackOfficeIdentityUser)

Declaration

public override async Task<IdentityResult> ResetAccessFailedCountAsync(BackOfficeIdentityUser user)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.IdentityResult>

SetLockoutEndDateAsync(BackOfficeIdentityUser, Nullable<DateTimeOffset>)

Declaration

public override async Task<IdentityResult> SetLockoutEndDateAsync(BackOfficeIdentityUser user, DateTimeOffset? lockoutEnd)

Parameters

Type	Name	Description
BackOfficeIdentityUser	user
System.Nullable<System.DateTimeOffset>	lockoutEnd

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.IdentityResult>

VerifyPasswordAsync(IUserPasswordStore<BackOfficeIdentityUser>, BackOfficeIdentityUser, String)

Override to allow checking the password via the IBackOfficeUserPasswordChecker if one is configured

Declaration

protected override async Task<PasswordVerificationResult> VerifyPasswordAsync(IUserPasswordStore<BackOfficeIdentityUser> store, BackOfficeIdentityUser user, string password)

Parameters

Type	Name	Description
Microsoft.AspNetCore.Identity.IUserPasswordStore<BackOfficeIdentityUser>	store
BackOfficeIdentityUser	user
System.String	password

Returns

Type	Description
System.Threading.Tasks.Task<Microsoft.AspNetCore.Identity.PasswordVerificationResult>