Skip to main content
Interface defining the available methods and properties for the mfa-push-challenge-push screen
Example
export interface MfaPushChallengePushMembers extends BaseMembers {
  screen: ScreenMembersOnMfaPushChallengePush;
  untrustedData: UntrustedDataMembersOnMfaPushChallengePush;

  /**
   * Continues with the push notification challenge
   * @param payload Optional custom options to include with the request
   */
  continue(payload?: WithRememberOptions): Promise<void>;

  /**
   * Resends the push notification
   * @param payload Optional custom options to include with the request
   */
  resendPushNotification(payload?: WithRememberOptions): Promise<void>;

  /**
   * Switches to entering the verification code manually
   * @param payload Optional custom options to include with the request
   */
  enterCodeManually(payload?: CustomOptions): Promise<void>;

  /**
   * Allows trying another authentication method
   * @param payload Optional custom options to include with the request
   */
  tryAnotherMethod(payload?: CustomOptions): Promise<void>;

  /** 
   * Manages polling for MFA push challenge status
   * @param options Configuration options for polling of type {@link MfaPollingOptions}
   * @returns An object to control the polling process
  */
  pollingManager(options: MfaPollingOptions): MfaPushPollingControl;
}

Properties

branding
client
organization
prompt
screen
tenant
transaction
untrustedData
user

Methods

continue
Promise<void>
Continues with the push notification challenge
enterCodeManually
Promise<void>
Switches to entering the verification code manually
pollingManager
Manages polling for MFA push challenge statusAn object to control the polling process
resendPushNotification
Promise<void>
Resends the push notification
tryAnotherMethod
Promise<void>
Allows trying another authentication method