Reset Password screen classes
Reset Password screen class
The Reset Password screen class is part of the Identifier First Authentication flow and resets the user's password.

Import and instantiate the Reset Password screen class
import ResetPassword from '@auth0/auth0-acul-js/reset-password';
const resetPasswordManager = new ResetPassword();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
resetPasswordManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
resetPasswordManager.screenLinks();
feedbackSection.helpful
Properties
The Reset Password screen class properties are:
interface branding {
settings: null | BrandingSettings;
themes: null | BrandingThemes;
}
interface BrandingSettings {
colors?: {
pageBackground?: string | {
angleDeg: number;
end: string;
start: string;
type: string;
};
primary?: string;
};
faviconUrl?: string;
font?: {url: string;};
logoUrl?: string;
}
interface BrandingThemes {
default: {
borders: Record<string, string | number | boolean>;
colors: Record<string, string>;
displayName: string;
fonts: Record<string, string | boolean | object>;
pageBackground: Record<string, string>;
widget: Record<string, string | number>;
};
}
feedbackSection.helpful
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
feedbackSection.helpful
interface organization {
branding: null | {
colors?: {
pageBackground?: string;
primary?: string;
};
logoUrl?: string;
};
displayName: null | string;
id: null | string;
metadata: null | {[key: string]: string;};
name: null | string;
usage: null | string;
}
feedbackSection.helpful
interface prompt{
name: string;
}
feedbackSection.helpful
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {username?: string;};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
feedbackSection.helpful
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
feedbackSection.helpful
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
locale: string;
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
displayName?: string;
iconUrl?: string;
showAsButton: boolean;
};
strategy: string;
}
feedbackSection.helpful
interface untrustedData {
authorizationParams: null | {
login_hint?: string;
screen_hint?: string;
ui_locales?: string;
[key: `ext-${string}`]: string;
};
submittedFormData: null | {
[key: string]:
| string
| number
| boolean
| undefined;
};
}
feedbackSection.helpful
interface user {
appMetadata: null | {[key: string]: string;};
email: null | string;
enrolledDevices: null | string[];
enrolledEmails: null | string[];
enrolledFactors: null | string[];
enrolledPhoneNumbers: null | string[];
id: null | string;
organizations: null | {
branding: undefined | {logoUrl: undefined | string;};
displayName: undefined | string;
organizationId: undefined | string;
organizationName: undefined | string;
}[];
phoneNumber: null | string;
picture: null | string;
userMetadata: null | {[key: string]: string;};
username: null | string;
}
feedbackSection.helpful
Methods
The Reset Password screen class method is:
resetPassword( options? )
This method prompts the user for an email to send instructions to reset their password.
import ResetPassword from '@auth0/auth0-acul-js/reset-password';
const resetPassword = new ResetPassword();
resetPassword.resetPassword({
'password-reset': 'Test@123!',
're-enter-password': 'Test@123!',
});
feedbackSection.helpful
Parameter | Type | Required | Description |
---|---|---|---|
password |
string | Yes | The user's password. |
re-enter-password |
string | Yes | The user's password. |
[key: string] |
string | number | boolean | undefined | No | Additional data collected from the user. |
Reset Password Email screen class
The Reset Password Email screen class is part of the Identifier First Authentication flow and sends the user email instructions to reset their password.

Import and instantiate the Reset Password Email screen class
import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email';
const resetPasswordEmailManager = new ResetPasswordEmail();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
resetPasswordEmailManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
resetPasswordEmailManager.screenLinks();
feedbackSection.helpful
Properties
The Reset Password Email screen class properties are:
interface branding {
settings: null | BrandingSettings;
themes: null | BrandingThemes;
}
interface BrandingSettings {
colors?: {
pageBackground?: string | {
angleDeg: number;
end: string;
start: string;
type: string;
};
primary?: string;
};
faviconUrl?: string;
font?: {url: string;};
logoUrl?: string;
}
interface BrandingThemes {
default: {
borders: Record<string, string | number | boolean>;
colors: Record<string, string>;
displayName: string;
fonts: Record<string, string | boolean | object>;
pageBackground: Record<string, string>;
widget: Record<string, string | number>;
};
}
feedbackSection.helpful
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
feedbackSection.helpful
interface organization {
branding: null | {
colors?: {
pageBackground?: string;
primary?: string;
};
logoUrl?: string;
};
displayName: null | string;
id: null | string;
metadata: null | {[key: string]: string;};
name: null | string;
usage: null | string;
}
feedbackSection.helpful
interface prompt{
name: string;
}
feedbackSection.helpful
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {username?: string;};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
feedbackSection.helpful
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
feedbackSection.helpful
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
locale: string;
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
displayName?: string;
iconUrl?: string;
showAsButton: boolean;
};
strategy: string;
}
feedbackSection.helpful
interface untrustedData {
authorizationParams: null | {
login_hint?: string;
screen_hint?: string;
ui_locales?: string;
[key: `ext-${string}`]: string;
};
submittedFormData: null | {
[key: string]:
| string
| number
| boolean
| undefined;
};
}
feedbackSection.helpful
interface user {
appMetadata: null | {[key: string]: string;};
email: null | string;
enrolledDevices: null | string[];
enrolledEmails: null | string[];
enrolledFactors: null | string[];
enrolledPhoneNumbers: null | string[];
id: null | string;
organizations: null | {
branding: undefined | {logoUrl: undefined | string;};
displayName: undefined | string;
organizationId: undefined | string;
organizationName: undefined | string;
}[];
phoneNumber: null | string;
picture: null | string;
userMetadata: null | {[key: string]: string;};
username: null | string;
}
feedbackSection.helpful
Methods
The Reset Password Email screen class method is:
resendEmail( options? )
This method resends an email with instructions to reset their password. .
import ResetPasswordEmail from '@auth0/auth0-acul-js/reset-password-email';
const resetPasswordEmail = new ResetPasswordEmail();
resetPasswordEmail.resendEmail();
feedbackSection.helpful
Parameter | Type | Required | Description |
---|---|---|---|
[key: string] |
string | number | boolean | undefined | No | Additional data collected from the user. |
Reset Password Error screen class
The Reset Password Error screen class is part of the Identifier First Authentication flow and sends the user back to your application.

Import and instantiate the Reset Password Error screen class
import ResetPasswordError from '@auth0/auth0-acul-js/reset-password-error';
const resetPasswordErrorManager = new ResetPasswordError();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
resetPasswordErrorManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
resetPasswordErrorManager.screenLinks();
feedbackSection.helpful
Properties
The Reset Password Error screen class properties are:
interface branding {
settings: null | BrandingSettings;
themes: null | BrandingThemes;
}
interface BrandingSettings {
colors?: {
pageBackground?: string | {
angleDeg: number;
end: string;
start: string;
type: string;
};
primary?: string;
};
faviconUrl?: string;
font?: {url: string;};
logoUrl?: string;
}
interface BrandingThemes {
default: {
borders: Record<string, string | number | boolean>;
colors: Record<string, string>;
displayName: string;
fonts: Record<string, string | boolean | object>;
pageBackground: Record<string, string>;
widget: Record<string, string | number>;
};
}
feedbackSection.helpful
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
feedbackSection.helpful
interface organization {
branding: null | {
colors?: {
pageBackground?: string;
primary?: string;
};
logoUrl?: string;
};
displayName: null | string;
id: null | string;
metadata: null | {[key: string]: string;};
name: null | string;
usage: null | string;
}
feedbackSection.helpful
interface prompt{
name: string;
}
feedbackSection.helpful
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {username?: string;};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
feedbackSection.helpful
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
feedbackSection.helpful
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
locale: string;
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
displayName?: string;
iconUrl?: string;
showAsButton: boolean;
};
strategy: string;
}
feedbackSection.helpful
interface untrustedData {
authorizationParams: null | {
login_hint?: string;
screen_hint?: string;
ui_locales?: string;
[key: `ext-${string}`]: string;
};
submittedFormData: null | {
[key: string]:
| string
| number
| boolean
| undefined;
};
}
feedbackSection.helpful
interface user {
appMetadata: null | {[key: string]: string;};
email: null | string;
enrolledDevices: null | string[];
enrolledEmails: null | string[];
enrolledFactors: null | string[];
enrolledPhoneNumbers: null | string[];
id: null | string;
organizations: null | {
branding: undefined | {logoUrl: undefined | string;};
displayName: undefined | string;
organizationId: undefined | string;
organizationName: undefined | string;
}[];
phoneNumber: null | string;
picture: null | string;
userMetadata: null | {[key: string]: string;};
username: null | string;
}
feedbackSection.helpful
Reset Password Request screen class
The Reset Password Request screen class is part of the Identifier First Authentication flow and prompts the user for an email to send reset password instructions.
![]() |
Import and instantiate the Reset Password Request screen class
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequestManager = new ResetPasswordRequest();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
resetPasswordRequestManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
resetPasswordRequestManager.screenLinks();
feedbackSection.helpful
Properties
The Reset Password Request screen class properties are:
interface branding {
settings: null | BrandingSettings;
themes: null | BrandingThemes;
}
interface BrandingSettings {
colors?: {
pageBackground?: string | {
angleDeg: number;
end: string;
start: string;
type: string;
};
primary?: string;
};
faviconUrl?: string;
font?: {url: string;};
logoUrl?: string;
}
interface BrandingThemes {
default: {
borders: Record<string, string | number | boolean>;
colors: Record<string, string>;
displayName: string;
fonts: Record<string, string | boolean | object>;
pageBackground: Record<string, string>;
widget: Record<string, string | number>;
};
}
feedbackSection.helpful
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
feedbackSection.helpful
interface organization {
branding: null | {
colors?: {
pageBackground?: string;
primary?: string;
};
logoUrl?: string;
};
displayName: null | string;
id: null | string;
metadata: null | {[key: string]: string;};
name: null | string;
usage: null | string;
}
feedbackSection.helpful
interface prompt{
name: string;
}
feedbackSection.helpful
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {
email?: string;
username?: string;
};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
feedbackSection.helpful
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
feedbackSection.helpful
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
locale: string;
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
displayName?: string;
iconUrl?: string;
showAsButton: boolean;
};
strategy: string;
}
feedbackSection.helpful
interface untrustedData {
authorizationParams: null | {
login_hint?: string;
screen_hint?: string;
ui_locales?: string;
[key: `ext-${string}`]: string;
};
submittedFormData: null | {
[key: string]:
| string
| number
| boolean
| undefined;
};
}
feedbackSection.helpful
interface user {
appMetadata: null | {[key: string]: string;};
email: null | string;
enrolledDevices: null | string[];
enrolledEmails: null | string[];
enrolledFactors: null | string[];
enrolledPhoneNumbers: null | string[];
id: null | string;
organizations: null | {
branding: undefined | {logoUrl: undefined | string;};
displayName: undefined | string;
organizationId: undefined | string;
organizationName: undefined | string;
}[];
phoneNumber: null | string;
picture: null | string;
userMetadata: null | {[key: string]: string;};
username: null | string;
}
feedbackSection.helpful
Methods
The Reset Password Request screen class method are:
backToLogin( options? )
This method takes the user back your application to login.
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.backToLogin();
feedbackSection.helpful
Parameter | Type | Required | Description |
---|---|---|---|
[key: string] |
string | number | boolean | undefined | No | Optional data collected from user. |
resetPassword( options? )
This method prompts the user to enter their email address or username to receive reset password instructions.
import ResetPasswordRequest from '@auth0/auth0-acul-js/reset-password-request';
const resetPasswordRequest = new ResetPasswordRequest();
resetPasswordRequest.resetPassword({ username: 'testuser' });
feedbackSection.helpful
Parameter | Type | Required | Description |
---|---|---|---|
captcha |
string | Conditionally | The captcha code or response from the captcha provider. This property is required if your Auth0 tenant has Bot Detection enabled. |
email |
string | Conditionally | The user’s email. |
[key: string] |
string | number | boolean | undefined | No | Additional data collected from the user. |
Reset Password Success screen class
The Reset Password Success screen class is part of the Identifier First Authentication flow and confirms the password change and returns the user to your application.

Import and instantiate the Reset Password Success screen class
import ResetPasswordSuccess from '@auth0/auth0-acul-js/reset-password-success';
const resetPasswordSuccessManager = new ResetPasswordSuccess();
// SDK Properties return a string, number or boolean
// ex. "signup-id"
resetPasswordSuccessManager.screen.name;
// SDK Methods return an object or array
// ex. { login: "/login_url"}
resetPasswordSuccessManager.screenLinks();
feedbackSection.helpful
Properties
The Reset Password Success screen class properties are:
interface branding {
settings: null | BrandingSettings;
themes: null | BrandingThemes;
}
interface BrandingSettings {
colors?: {
pageBackground?: string | {
angleDeg: number;
end: string;
start: string;
type: string;
};
primary?: string;
};
faviconUrl?: string;
font?: {url: string;};
logoUrl?: string;
}
interface BrandingThemes {
default: {
borders: Record<string, string | number | boolean>;
colors: Record<string, string>;
displayName: string;
fonts: Record<string, string | boolean | object>;
pageBackground: Record<string, string>;
widget: Record<string, string | number>;
};
}
feedbackSection.helpful
interface client {
description: null | string;
id: string;
logoUrl: null | string;
name: string;
metadata: null | {[key: string]: string;};
}
feedbackSection.helpful
interface organization {
branding: null | {
colors?: {
pageBackground?: string;
primary?: string;
};
logoUrl?: string;
};
displayName: null | string;
id: null | string;
metadata: null | {[key: string]: string;};
name: null | string;
usage: null | string;
}
feedbackSection.helpful
interface prompt{
name: string;
}
feedbackSection.helpful
interface screen {
captcha: null | CaptchaContext;
captchaImage: null | string;
captchaProvider: null | string;
captchaSiteKey: null | string;
data: null | {username?: string;};
isCaptchaAvailable: boolean;
links: null | Record<string, string>;
name: string;
texts: null | Record<string, string>;
}
interface CaptchaContext {
image?: string;
provider: string;
siteKey?: string;
}
feedbackSection.helpful
interface tenant {
enabledFactors: null | string[];
enabledLocales: null | string[];
friendlyName: null | string;
name: null | string;
}
feedbackSection.helpful
interface transaction {
alternateConnections: null | (Connection | EnterpriseConnection)[];
connectionStrategy: null | string;
countryCode: null | string;
countryPrefix: null | string;
currentConnection: null | Connection;
errors: null | Error[];
hasErrors: boolean;
locale: string;
state: string;
}
interface Connection {
metadata?: Record<string, string>;
name: string;
strategy: string;
}
interface EnterpriseConnection {
metadata?: Record<string, string>;
name: string;
options: {
displayName?: string;
iconUrl?: string;
showAsButton: boolean;
};
strategy: string;
}
feedbackSection.helpful
interface untrustedData {
authorizationParams: null | {
login_hint?: string;
screen_hint?: string;
ui_locales?: string;
[key: `ext-${string}`]: string;
};
submittedFormData: null | {
[key: string]:
| string
| number
| boolean
| undefined;
};
}
feedbackSection.helpful
interface user {
appMetadata: null | {[key: string]: string;};
email: null | string;
enrolledDevices: null | string[];
enrolledEmails: null | string[];
enrolledFactors: null | string[];
enrolledPhoneNumbers: null | string[];
id: null | string;
organizations: null | {
branding: undefined | {logoUrl: undefined | string;};
displayName: undefined | string;
organizationId: undefined | string;
organizationName: undefined | string;
}[];
phoneNumber: null | string;
picture: null | string;
userMetadata: null | {[key: string]: string;};
username: null | string;
}
feedbackSection.helpful