View Source

Interface ICoreBackOfficeUserManager

Provides core user management functionality for back office users.

Namespace: Umbraco.Cms.Core.Security

Assembly: Umbraco.Core.dll

Syntax

public interface ICoreBackOfficeUserManager

Methods

CreateAsync(UserCreateModel)

Creates a new back office user.

Declaration

Task<IdentityCreationResult> CreateAsync(UserCreateModel createModel)

Parameters

Type	Name	Description
UserCreateModel	createModel	The model containing the user creation details.

Returns

Type	Description
Task<IdentityCreationResult>	A task that resolves to the result of the user creation operation.

CreateForInvite(UserCreateModel)

Creates a user for an invite. This means that the password will not be populated.

Declaration

Task<IdentityCreationResult> CreateForInvite(UserCreateModel createModel)

Parameters

Type	Name	Description
UserCreateModel	createModel	The model containing the user creation details.

Returns

Type	Description
Task<IdentityCreationResult>	A task that resolves to the result of the user creation operation.

GenerateEmailConfirmationTokenAsync(IUser)

Generates an email confirmation token for the specified user.

Declaration

Task<Attempt<string, UserOperationStatus>> GenerateEmailConfirmationTokenAsync(IUser user)

Parameters

Type	Name	Description
IUser	user	The user to generate the token for.

Returns

Type	Description
Task<Attempt<string, UserOperationStatus>>	An attempt containing the generated token or an error status.

GeneratePassword()

Generates a random password that meets the configured password requirements.

Declaration

string GeneratePassword()

Returns

Type	Description
string	A randomly generated password.

GeneratePasswordResetTokenAsync(IUser)

Generates a password reset token for the specified user.

Declaration

Task<Attempt<string, UserOperationStatus>> GeneratePasswordResetTokenAsync(IUser user)

Parameters

Type	Name	Description
IUser	user	The user to generate the token for.

Returns

Type	Description
Task<Attempt<string, UserOperationStatus>>	An attempt containing the generated token or an error status.

GetLoginsAsync(IUser)

Gets all external logins associated with the specified user.

Declaration

Task<Attempt<ICollection<IIdentityUserLogin>, UserOperationStatus>> GetLoginsAsync(IUser user)

Parameters

Type	Name	Description
IUser	user	The user to get logins for.

Returns

Type	Description
Task<Attempt<ICollection<IIdentityUserLogin>, UserOperationStatus>>	An attempt containing the collection of logins or an error status.

IsEmailConfirmationTokenValidAsync(IUser, string)

Validates whether the email confirmation token is valid for the specified user.

Declaration

Task<bool> IsEmailConfirmationTokenValidAsync(IUser user, string token)

Parameters

Type	Name	Description
IUser	user	The user to validate the token for.
string	token	The token to validate.

Returns

Type	Description
Task<bool>	true if the token is valid; otherwise, false.

IsResetPasswordTokenValidAsync(IUser, string)

Validates whether the password reset token is valid for the specified user.

Declaration

Task<bool> IsResetPasswordTokenValidAsync(IUser user, string token)

Parameters

Type	Name	Description
IUser	user	The user to validate the token for.
string	token	The token to validate.

Returns

Type	Description
Task<bool>	true if the token is valid; otherwise, false.

NotifyForgotPasswordRequested(IPrincipal, string)

Notifies that a forgot password request was made.

Declaration

void NotifyForgotPasswordRequested(IPrincipal user, string toString)

Parameters

Type	Name	Description
IPrincipal	user	The principal of the user who requested the password reset.
string	toString	Additional information about the request.

UnlockUser(IUser)

Unlocks the specified user account.

Declaration

Task<Attempt<UserUnlockResult, UserOperationStatus>> UnlockUser(IUser user)

Parameters

Type	Name	Description
IUser	user	The user to unlock.

Returns

Type	Description
Task<Attempt<UserUnlockResult, UserOperationStatus>>	An attempt containing the unlock result or an error status.