Interface MfaEmailChallengeMembers

Interface defining the available methods and properties for the mfa-email-challenge screen

interface MfaEmailChallengeMembers {
    branding: Classes.BrandingMembers;
    client: Classes.ClientMembers;
    organization: Classes.OrganizationMembers;
    prompt: Classes.PromptMembers;
    screen: Classes.ScreenMembersOnMfaEmailChallenge;
    tenant: Classes.TenantMembers;
    transaction: Classes.TransactionMembers;
    untrustedData: Classes.UntrustedDataMembersOnMfaEmailChallenge;
    user: Classes.UserMembers;
    continue(payload: Classes.ContinuePayloadOptions): Promise<void>;
    resendCode(payload?: Classes.ResendCodePayloadOptions): Promise<void>;
    tryAnotherMethod(
        payload?: Classes.TryAnotherMethodPayloadOptions,
    ): Promise<void>;
}

Hierarchy

BaseMembers
- MfaEmailChallengeMembers

Implemented by

MfaEmailChallenge

Index

Properties

branding client organization prompt screen tenant transaction untrustedData user

Methods

continue resendCode tryAnotherMethod

Properties

branding

branding: Classes.BrandingMembers

client

client: Classes.ClientMembers

organization

organization: Classes.OrganizationMembers

prompt

prompt: Classes.PromptMembers

screen

screen: Classes.ScreenMembersOnMfaEmailChallenge

tenant

tenant: Classes.TenantMembers

transaction

transaction: Classes.TransactionMembers

untrustedData

untrustedData: Classes.UntrustedDataMembersOnMfaEmailChallenge

user

user: Classes.UserMembers

Methods

continue

continue(payload: Classes.ContinuePayloadOptions): Promise<void>
Continues with the email challenge using the provided code
Parameters
- payload: Classes.ContinuePayloadOptions
  The options containing the code and rememberDevice flag
Returns Promise<void>
- Defined in interfaces/screens/mfa-email-challenge.ts:63

resendCode

resendCode(payload?: Classes.ResendCodePayloadOptions): Promise<void>
Resends the email code
Parameters
- Optionalpayload: Classes.ResendCodePayloadOptions
  Optional custom options to include with the request
Returns Promise<void>
- Defined in interfaces/screens/mfa-email-challenge.ts:69

tryAnotherMethod

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