Interface MfaEmailChallengeMembers

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

interface MfaEmailChallengeMembers {
    branding: BrandingMembers;
    client: ClientMembers;
    organization: OrganizationMembers;
    prompt: PromptMembers;
    screen: ScreenMembersOnMfaEmailChallenge;
    tenant: TenantMembers;
    transaction: TransactionMembers;
    untrustedData: UntrustedDataMembers;
    user: UserMembers;
    continue(payload: ContinuePayloadOptions): Promise<void>;
    resendCode(payload?: ResendCodePayloadOptions): Promise<void>;
    tryAnotherMethod(payload?: 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: BrandingMembers

client

client: ClientMembers

organization

organization: OrganizationMembers

prompt

prompt: PromptMembers

screen

screen: ScreenMembersOnMfaEmailChallenge

tenant

tenant: TenantMembers

transaction

transaction: TransactionMembers

untrustedData

untrustedData: UntrustedDataMembers

user

user: UserMembers

Methods

continue

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

resendCode

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

tryAnotherMethod

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