MfaLoginOptionsMembers

Interface defining the available methods and properties for the mfa-login-options screen

Example

export interface MfaLoginOptionsMembers extends BaseMembers {
  screen: ScreenMembersOnMfaLoginOptions;
  /**
   * Continues the login process with the selected MFA factor
   * @param payload The options containing the selected factor
   * @example
   * ```typescript
   * const mfaLoginOptions = new MfaLoginOptions();
   * await mfaLoginOptions.enroll({
   *   action: 'push-notification'
   * });
   * ```
   */
  enroll(payload: LoginEnrollOptions): Promise<void>;
  /**
   * Returns to the previous screen in the authentication flow
   * @param payload Optional custom options
   * @example
   * ```typescript
   * const mfaLoginOptions = new MfaLoginOptions();
   * await mfaLoginOptions.returnToPrevious();
   * ```
   */
  returnToPrevious(payload?: CustomOptions): Promise<void>;
}

Properties

branding · BrandingMembers

client · ClientMembers

organization · OrganizationMembers

prompt · PromptMembers

screen · ScreenMembersOnMfaLoginOptions

tenant · TenantMembers

transaction · TransactionMembers

untrustedData · UntrustedDataMembers

user · UserMembers

Methods

enroll · Promise<void>

Continues the login process with the selected MFA factor

Example

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.enroll({
  action: 'push-notification'
});

Show Parameters

payload · LoginEnrollOptions

The options containing the selected factor

Properties

action · MfaLoginFactorType

The action indicating which factor to use for login

returnToPrevious · Promise<void>

Returns to the previous screen in the authentication flow

Example

const mfaLoginOptions = new MfaLoginOptions();
await mfaLoginOptions.returnToPrevious();

Show Parameters

payload? · CustomOptions

Optional custom options