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 where it can be edited and customized for branding purposes. The files for the form are located in the /web/templates/change_password directory:

password-change-template.zoom80

Method

Future<void> Backendless.userService.restorePassword(String identity);

where

Argument                Description
identity 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.

Example

// do not forget to call Backendless.initApp in the app initialization code 
Backendless.userService.restorePassword("james.bond").then((response) {
  // Backendless has completed the operation - an email has been sent to the user
});