Skip to main content
The ResetPassword class implements the reset-password screen functionality. This screen allows the user to set a new password after verifying their identity.
ACUL Reset password

​
Constructors

Create an instance of ResetPassword screen manager
Example
import ResetPassword from '@auth0/auth0-acul-js/reset-password';
const resetPasswordManager = new ResetPassword();
resetPasswordManager.resetPassword({
  'password-reset': 'Test@123!',
  're-enter-password': 'Test@123!',
});

​
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 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
ScreenMembersOnResetPassword
Contains details specific to the reset-password screen, including its configuration and context.
​
tenant
TenantMembers
Contains data related to the tenant, such as id and associated metadata.
​
transaction
TransactionMembersOnResetPassword
Provides transaction-specific data for the reset-password 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 flow.
​
user
UserMembers
Details of the active user, including username, email, and roles.

​
Methods

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

const resetPasswordManager = new ResetPassword();
resetPasswordManager.resetPassword({
  'password-reset': 'Test@123!',
  're-enter-password': 'Test@123!',
});
​
options
OPTIONAL
Optional payload.
​
validatePassword
PasswordValidationResult
This method validates a password string against the tenant’s password policy and returns a validation result.
Example
import ResetPassword from '@auth0/auth0-acul-js/reset-password';

const resetPasswordManager = new ResetPassword();
resetPasswordManager.validatePassword('MyP@ssw0rd!');
​
options
OPTIONAL
Optional payload.
​
getErrors
Error[]
This method retrieves the array of transaction errors from the context, or an empty array if none exist.