Interface MfaPhoneEnrollmentMembers

Options for continuing with the MFA phone enrollment.

interface MfaPhoneEnrollmentMembers {
    branding: Classes.BrandingMembers;
    client: Classes.ClientMembers;
    organization: Classes.OrganizationMembers;
    prompt: Classes.PromptMembers;
    screen: Classes.ScreenMembers;
    tenant: Classes.TenantMembers;
    transaction: Classes.TransactionMembers;
    untrustedData: Classes.UntrustedDataMembers;
    user: Classes.UserMembers;
    continueEnrollment(
        payload: { phone: string; type: "sms" | "voice" },
    ): Promise<void>;
    pickCountryCode(payload?: Classes.CustomOptions): Promise<void>;
    tryAnotherMethod(payload?: Classes.CustomOptions): Promise<void>;
}

Hierarchy

BaseMembers
- MfaPhoneEnrollmentMembers

Implemented by

MfaPhoneEnrollment

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

continueEnrollment pickCountryCode tryAnotherMethod

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembers

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembers

user

user: Classes.UserMembers

Methods

continueEnrollment

continueEnrollment(
payload: { phone: string; type: "sms" | "voice" },
): Promise<void>
Continues the enrollment process with the provided phone number and type (SMS or voice).
Parameters
- payload: { phone: string; type: "sms" | "voice" }
  The phone number and type (SMS or voice).
Returns Promise<void>
- Defined in interfaces/screens/mfa-phone-enrollment.ts:28

pickCountryCode

pickCountryCode(payload?: Classes.CustomOptions): Promise<void>
Selects the country code for the phone number.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
- Defined in interfaces/screens/mfa-phone-enrollment.ts:22

tryAnotherMethod

tryAnotherMethod(payload?: Classes.CustomOptions): Promise<void>
Allows the user to try another MFA method.
Parameters
- Optionalpayload: Classes.CustomOptions
  Optional custom options to include with the request.
Returns Promise<void>
- Defined in interfaces/screens/mfa-phone-enrollment.ts:34