View Source

Class ForgotPasswordUriProvider

Provides URIs used in the forgot password process for user account recovery.

Inheritance

object

Namespace: Umbraco.Cms.Api.Management.Security

Assembly: Umbraco.Cms.Api.Management.dll

Syntax

public class ForgotPasswordUriProvider : IForgotPasswordUriProvider

Constructors

ForgotPasswordUriProvider(ICoreBackOfficeUserManager, IHostingEnvironment, IHttpContextAccessor)

Initializes a new instance of the ForgotPasswordUriProvider class.

Declaration

public ForgotPasswordUriProvider(ICoreBackOfficeUserManager userManager, IHostingEnvironment hostingEnvironment, IHttpContextAccessor httpContextAccessor)

Parameters

Type	Name	Description
ICoreBackOfficeUserManager	userManager	An ICoreBackOfficeUserManager instance for managing back office users.
IHostingEnvironment	hostingEnvironment	An IHostingEnvironment instance representing the current hosting environment.
IHttpContextAccessor	httpContextAccessor	An Microsoft.AspNetCore.Http.IHttpContextAccessor instance for accessing the current HTTP context.

Methods

CreateForgotPasswordUriAsync(IUser)

Creates a forgot password URI for the specified user.

Declaration

public Task<Attempt<Uri, UserOperationStatus>> CreateForgotPasswordUriAsync(IUser user)

Parameters

Type	Name	Description
IUser	user	The user to create the forgot password URI for.

Returns

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