Skip to content

Password Reset

Backendless supports two types of password reset:

  1. Reset to a system (backend) generated password.
  2. Reset to a password assigned by the user.

With the first option, an email is sent to the user with a regenerated system-assigned password. With the second option, an email is sent with a link to a webpage which contains a form where the user can enter the new password.

You can choose the type of reset using Backendless Console - click the Messaging icon in the vertical icon bar on the left and then select the EMAILS tab. You will see several available templates, however the ones  responsible for password reset are called User requests password recovery or User requests password recovery by link. Only one of these options can be active at a time. To make an option active, make sure the Do not send email for the event checkbox is not selected. If you make a change, make sure to click the SAVE button at the bottom of the screen.

For example, the following screenshot shows a configuration where the system will send out a link so the user can assign their own password. Notice the red color for the User requests password recovery option - this indicated that the option is disabled for the app:

password-reset-option-selected

In both cases (system-assigned or user-assigned passwords), the password reset sequence must initiated through the API documented below.

For the "User requests password recovery by link" option Backendless provides a default HTML form the link in the email points to. The HTML page is located in the File storage of the application, however, to edit the file and optionally change its logic, you must use the Backendless UI Builder. To do this, navigate to the FRONTEND section of Backendless Console and select the system UI Container:

system-ui-container

Select the change-password page:

change-password

If you make any changes to the confirmation pages, make sure to re-publish the system UI Container by clicking the Publish UI Container icon:

publish-ui-container

It is important that the UI Container is published to the system directory located under the web directory:

system-under-web

Non-Blocking API

The method call does not block - it returns immediately. The AsyncCallback argument receives either the response or the fault returned by the Backendless servers.

public void Backendless.UserService.restorePassword( String identityValue, 
                                                     AsyncCallback<Void> callback )

where

Argument                Description
identityValue a value for the property marked as identity which uniquely identifies the user within the application.
callback an object which is notified when the server completes the operation or returns an error. The class must implement the AsyncCallback<Void> interface.

Blocking API

public void Backendless.UserService.restorePassword( String identityValue ) 
                                                    throws BackendlessException;

where

Argument                Description
identityValue a value for the property marked as identity which uniquely identifies the user within the application.

Errors

The following errors may occur during the Password Recovery API call. See the Error Handling section for details on how to retrieve the error code when the server returns an error.

Error Code
Description
2002
Version is disabled or provided wrong application info (application id or secret key)
3020
Unable to find user with the specified login (invalid user identity).
3025
General password recovery error. Additional details should be available in the "message" property of the response.
3038
One of the requirement arguments (application id, version or user identity) is missing.

Non-Blocking API Example

// do not forget to call Backendless.initApp in the app initialization code 

Backendless.UserService.restorePassword( "james.bond", new AsyncCallback<Void>()
{
 public void handleResponse( Void response )
  {
    // Backendless has completed the operation - an email has been sent to the user
  }

  public void handleFault( BackendlessFault fault )
  {
    // password revovery failed, to get the error code call fault.getCode()
  }
});

Blocking API Example

// do not forget to call Backendless.initApp in the app initialization code 

try
{
 Backendless.UserService.restorePassword( "james.bond" );
}
catch( BackendlessException exception )
{
  // password recovery failed, to get the error code, call exception.getFault().getCode()
}