ResetPasswordMfaPhoneChallenge

ResetPasswordMfaPhoneChallenge

Example

const screen = new ResetPasswordMfaPhoneChallenge();
try {
  await screen.continue({ type: 'sms' });
  // Redirects to code entry screen on success
} catch (error) {
  console.error("Failed to send SMS code:", error);
}

Constructors

ResetPasswordMfaPhoneChallenge · Constructor

Initializes a new instance of the ResetPasswordMfaPhoneChallenge class. It retrieves the screen context and sets up the screen-specific properties.

Throws

If the Universal Login Context is not available or if the screen name doesn’t match.

Properties

branding

client

Access to client-specific information (e.g., client ID, name).

organization

Access to organization-specific information, if applicable.

prompt

Access to prompt details (e.g., prompt name).

screen

Holds the specific screen data and properties, processed by ScreenOverride.

tenant

transaction

Access to the current transaction details (e.g., state, errors).

untrustedData

user

screenIdentifier · string

The unique identifier for this screen, used internally and for telemetry.

Methods

continue · Promise<void>

Sends the verification code to the user’s phone via the selected method (SMS or Voice). Corresponds to the ‘Continue’ action in the OpenAPI definition (action: ‘default’).

A promise resolving upon successful submission to the server.

Throws

If the form submission fails.

Example

const screen = new ResetPasswordMfaPhoneChallenge();
try {
  await screen.continue({ type: 'sms' });
  // Redirects to code entry screen on success
} catch (error) {
  console.error("Failed to send SMS code:", error);
}

Show Parameters

payload

Contains the delivery type (sms or voice) and any optional custom data.

Properties

type · "sms" | "voice"

The delivery method selected by the user for receiving the verification code.

• sms: Send the code via text message.
• voice: Send the code via a voice call.

getErrors

Retrieves the array of transaction errors from the context, or an empty array if none exist.

An array of error objects from the transaction context.

tryAnotherMethod · Promise<void>

Initiates the process for the user to select a different MFA authenticator. Corresponds to the ‘Try Another Method’ action in the OpenAPI definition (action: ‘pick-authenticator’).

A promise resolving upon successful submission to the server.

Throws

If the form submission fails.

Example

const screen = new ResetPasswordMfaPhoneChallenge();
try {
  // Assuming the current screen was for SMS
  await screen.tryAnotherMethod({ type: 'sms' });
  // Redirects to authenticator selection screen on success
} catch (error) {
  console.error("Failed to switch MFA method:", error);
}

Show Parameters

payload

Contains the current challenge type (sms or voice) as required by the API, and any optional custom data.

Properties

type · "sms" | "voice"

The delivery method that was initially presented or selected on the current screen. This is required by the API endpoint to correctly process the ‘pick-authenticator’ action.

• sms: Indicates the current screen was for SMS challenge.
• voice: Indicates the current screen was for Voice challenge.