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.

ACUL Reset 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();

Was this 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>;
  };
}

Was this 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!',
});

Was this 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.

ACUL Reset_password_email

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();

Was this 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>;
  };
}

Was this 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();

Was this 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.

ACUL reset password error

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();

Was this 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>;
  };
}

Was this 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();

Was this 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>;
  };
}

Was this 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();

Was this 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' });

Was this 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.

ACUL Request password success

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();

Was this 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>;
  };
}

Was this helpful?

/

Reset Password MFA Email Challenge screen class

The Reset Password MFA Email Challenge screen class provides methods associated with the reset-password-mfa-email-challenge screen.

Import and instantiate the Reset Password MFA Email Challenge screen class:

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaOtpChallenge.screen.name;

// SDK Methods return an object or array
await resetPasswordMfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true,
});

Was this helpful?

/

Properties

The Reset Password MFA Email Challenge 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>;
  };
}

Was this helpful?

/

Methods

The Reset Password MFA Email Challenge screen class method are:

continue( options ?)

This method continues with the OTP challenge using the provided code.

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge();

await resetPasswordMfaEmailChallenge.continue({
  code: '123456',
  rememberDevice: true,
});

Was this helpful?

/

Parameter                  Type Required Description
code string Yes The code entered by the user.
rememberBrowser boolean No Remember the user's browser configuration.
[key: string] string | number | boolean | undefined No Optional data collected from user.

resendCode( options ?)

This method resends the OTP code by email. 

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge();

await resetPasswordMfaEmailChallenge.resendCode();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

tryAnotherMethod( options ?)

This method allows the user to try another MFA method.

import ResetPasswordMfaEmailChallenge from '@auth0/auth0-acul-js/reset-password-mfa-email-challenge';
const resetPasswordMfaEmailChallenge = new ResetPasswordMfaEmailChallenge();

await resetPasswordMfaEmailChallenge.tryAnotherMethod();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

Reset Password MFA OTP Challenge screen class

The Reset Password MFA OTP Challenge screen class provides methods associated with the reset-password-mfa-otp-challenge screen.

Import and instantiate the Reset Password MFA OTP Challenge screen class:

import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge';
const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge();

// SDK Properties return a string, number or boolean
// ex. "login-id"
resetPasswordMfaOtpChallenge.screen.name;

// SDK Methods return an object or array
await resetPasswordMfaOtpChallenge.continue({
  code: '123456',
});

Was this helpful?

/

Properties

The Reset Password MFA OTP Challenge 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>;
  };
}

Was this helpful?

/

Methods

The Reset Password MFA OTP Challenge screen class methods are:

continue( options ?)

This method continues with the OTP challenge using the provided code.

import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge';
const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge();

await resetPasswordMfaOtpChallenge.continue({
  code: '123456',
});

Was this helpful?

/

Parameter                  Type Required Description
code string Yes The code entered by the user.
[key: string] string | number | boolean | undefined No Optional data collected from user.

tryAnotherMethod( options ?)

This method allows the user to try another MFA method.

import ResetPasswordMfaOtpChallenge from '@auth0/auth0-acul-js/reset-password-mfa-otp-challenge';
const resetPasswordMfaOtpChallenge = new ResetPasswordMfaOtpChallenge();

await resetPasswordMfaOtpChallenge.tryAnotherMethod();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

Reset Password MFA Push Challenge Push screen class

The Reset Password MFA Push Challenge Push screen class provides methods associated with the reset-password-mfa-push-challenge-push screen. This screen is shown when a push notification has been sent to the user's device during password reset

Import and instantiate the Reset Password MFA Push Challenge Push screen class:

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();

// SDK Properties return a string, number or boolean
// ex. "login-id"
resetPasswordMfaPushChallengePush.screen.name;

// SDK Methods return an object or array
await resetPasswordMfaPushChallengePush.continue();

Was this helpful?

/

Properties

The Reset Password MFA Push Challenge Push 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>;
  };
}

Was this helpful?

/

Methods

The Reset Password MFA Push Challenge Push screen class methods are:

continue( options ?)

This method continues with the push notification challenge.

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();

await resetPasswordMfaPushChallengePush.continue();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

enterCodeManually( options ?)

This method allows the user to enter the verification code manually.

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();

await resetPasswordMfaPushChallengePush.enterCodeManually();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

resendPushNotification( options ?)

This method resends the push notification.

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();

await resetPasswordMfaPushChallengePush.resendPushNotification();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

tryAnotherMethod( options ?)

This method allows the user to try another method.

import ResetPasswordMfaPushChallengePush from '@auth0/auth0-acul-js/reset-password-mfa-push-challenge-push';
const resetPasswordMfaPushChallengePush = new ResetPasswordMfaPushChallengePush();

await resetPasswordMfaPushChallengePush.tryAnotherMethod();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

Reset Password MFA SMS Challenge screen class

The Reset Password MFA SMS Challenge screen class provides methods associated with the reset-password-mfa-sms-challenge screen.

Import and instantiate the Reset Password MFA SMS Challenge screen class:

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge();

// SDK Properties return a string, number or boolean
// ex. "login-id"
mfaOtpEnrollmentQr.screen.name;

// SDK Methods return an object or array
await resetPasswordMfaSmsChallenge.resendCode();

Was this helpful?

/

Properties

The Reset Password MFA SMS Challenge 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>;
  };
}

Was this helpful?

/

Methods

The Reset Password MFA SMS Challenge methods are:

continueMfaSmsChallenge( options ?)

This method submits the MFA SMS challenge with the provided code.

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge();

await resetPasswordMfaSmsChallenge.continueMfaSmsChallenge({
  code: '123456',
});

Was this helpful?

/

Parameter                  Type Required Description
code string Yes The code entered by the user.
[key: string] string | number | boolean | undefined No Optional data collected from user.

getACall( options ?)

This method submits the action to switch to voice call verification.

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge();

await resetPasswordMfaSmsChallenge.getACall();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

resendCode( options ?)

This method resends the SMS code.

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge();

await resetPasswordMfaSmsChallenge.resendCode();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.

tryAnotherMethod( options ?)

This method allows the user to try another MFA method.

import ResetPasswordMfaSmsChallenge from '@auth0/auth0-acul-js/reset-password-mfa-sms-challenge';
const resetPasswordMfaSmsChallenge = new ResetPasswordMfaSmsChallenge();

await resetPasswordMfaSmsChallenge.tryAnotherMethod();

Was this helpful?

/

Parameter                  Type Required Description
[key: string] string | number | boolean | undefined No Optional data collected from user.