Skip to main content
The ResetPasswordRequest class implements the reset-password-request screen functionality. This screen prompts the user to enter their identifier to initiate the password reset flow.

​
Constructors

Create an instance of ResetPasswordRequest screen manager
Example
import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request";
const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.getLoginIdentifiers();

​
Properties

​
branding
BrandingMembers
Provides branding-related configurations, such as branding theme and settings.
​
client
ClientMembers
Provides client-related configurations, such as id, name, and logoUrl, for the reset-password-request screen.
​
organization
OrganizationMembers
Provides information about the user’s organization, such as organization id and name.
​
prompt
PromptMembers
Contains data about the current prompt in the authentication flow.
​
screen
ScreenMembersOnResetPasswordRequest
Contains details specific to the reset-password-request screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnResetPasswordRequest
Provides transaction-specific data for the reset-password-request screen, such as active identifiers and flow states.
​
untrustedData
UntrustedDataMembers
Handles untrusted data passed to the SDK, such as user input during the password reset request flow.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

​
resetPassword
(options ?)
This method submits the user’s identifier to initiate the password reset flow.
Example
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.resetPassword({ username: 'testuser' });
​
options
OPTIONAL
Optional payload.
​
backToLogin
(options ?)
This method navigates the user back to the login screen.
Example
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';

const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.backToLogin();
​
options
OPTIONAL
Optional payload.
​
getLoginIdentifiers
ScreenIdentifierType[]
This method returns the active identifier types (such as username or email) configured for the reset-password-request screen.
Example
import ResetPasswordRequest from "@auth0/auth0-acul-js/reset-password-request";
const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.getLoginIdentifiers();
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.