Skip to main content
Interface defining the available methods and properties for the mfa-email-challenge screen
Example
export interface MfaEmailChallengeMembers extends BaseMembers {
  screen: ScreenMembersOnMfaEmailChallenge;
  untrustedData: UntrustedDataMembersOnMfaEmailChallenge;

  /**
   * Continues with the email challenge using the provided code
   * @param payload The options containing the code and rememberDevice flag
   */
  continue(payload: ContinueOptions): Promise<void>;

  /**
   * Resends the email code
   * @param payload Optional custom options to include with the request
   */
  resendCode(payload?: ResendCodeOptions): Promise<void>;

  /**
   * Allows the user to try another MFA method
   * @param payload Optional custom options to include with the request
   */
  tryAnotherMethod(payload?: TryAnotherMethodOptions): Promise<void>;

  /**
   * Submits the action to pick a different Email configuration, if available
   * @param payload Optional custom options to include with the request
   */
  pickEmail(payload?: CustomOptions): Promise<void>;

  /**
   * Gets resend functionality with timeout management for this screen
   * @param options Configuration options for resend functionality
   */
  resendManager(options?: StartResendOptions): ResendControl;
}

Properties

branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

continue
Promise<void>
Continues with the email challenge using the provided code
pickEmail
Promise<void>
Submits the action to pick a different Email configuration, if available
resendCode
Promise<void>
Resends the email code
resendManager
Gets resend functionality with timeout management for this screen
tryAnotherMethod
Promise<void>
Allows the user to try another MFA method