Options
All
  • Public
  • Public/Protected
  • All
Menu

Module recipe/multifactorauth

Index

Classes

Type Aliases

Variables

Functions

Type Aliases

GetRedirectionURLContext

GetRedirectionURLContext: NormalisedGetRedirectionURLContext<{ action: "FACTOR_CHOOSER"; nextFactorOptions?: string[]; stepUp?: boolean } | { action: "GO_TO_FACTOR"; factorId: string; forceSetup?: boolean; stepUp?: boolean }>

OnHandleEventContext

OnHandleEventContext: { action: "FACTOR_CHOOSEN"; factorId: string }

Type declaration

  • action: "FACTOR_CHOOSEN"
  • factorId: string

PreAPIHookContext

PreAPIHookContext: { action: PreAndPostAPIHookAction; requestInit: RequestInit; url: string; userContext: UserContext }

Type declaration

  • action: PreAndPostAPIHookAction
  • requestInit: RequestInit
  • url: string
  • userContext: UserContext

RecipeInterface

RecipeInterface: { resyncSessionAndFetchMFAInfo: any }

Type declaration

  • resyncSessionAndFetchMFAInfo:function
    • resyncSessionAndFetchMFAInfo(input: { options?: RecipeFunctionOptions; userContext: any }): Promise<{ emails: Record<string, string[] | undefined>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, string[] | undefined>; status: "OK" }>

    • Parameters

      • input: { options?: RecipeFunctionOptions; userContext: any }
        • Optional options?: RecipeFunctionOptions
        • userContext: any

      Returns Promise<{ emails: Record<string, string[] | undefined>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, string[] | undefined>; status: "OK" }>

UserInput

UserInput: { disableDefaultUI?: boolean; factorChooserScreen?: FeatureBaseConfig; firstFactors?: string[]; override?: { functions?: any }; getSecondaryFactorInfo?: any } & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>

Variables

Const FactorIds

FactorIds: { EMAILPASSWORD: "emailpassword"; LINK_EMAIL: "link-email"; LINK_PHONE: "link-phone"; OTP_EMAIL: "otp-email"; OTP_PHONE: "otp-phone"; THIRDPARTY: "thirdparty"; TOTP: "totp" } = ...

Type declaration

  • EMAILPASSWORD: "emailpassword"
  • LINK_EMAIL: "link-email"
  • LINK_PHONE: "link-phone"
  • OTP_EMAIL: "otp-email"
  • OTP_PHONE: "otp-phone"
  • THIRDPARTY: "thirdparty"
  • TOTP: "totp"

Const MultiFactorAuthClaim

MultiFactorAuthClaim: MultiFactorAuthClaimClass = MultiFactorAuthRecipe.MultiFactorAuthClaim

Const MultiFactorAuthComponentsOverrideProvider

MultiFactorAuthComponentsOverrideProvider: FC<PropsWithChildren<{ components: ComponentOverrideMap }>> = Wrapper.ComponentsOverrideProvider

Functions

init

redirectToFactor

  • redirectToFactor(input: { factorId: string; forceSetup?: boolean; navigate?: Navigate; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext }): Promise<void>

  • Parameters

    • input: { factorId: string; forceSetup?: boolean; navigate?: Navigate; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext }
      • factorId: string
      • Optional forceSetup?: boolean
      • Optional navigate?: Navigate
      • Optional redirectBack?: boolean
      • Optional stepUp?: boolean
      • Optional userContext?: UserContext

    Returns Promise<void>

redirectToFactorChooser

  • redirectToFactorChooser(input: { navigate?: Navigate; nextFactorOptions?: string[]; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext }): Promise<void>

  • Parameters

    • input: { navigate?: Navigate; nextFactorOptions?: string[]; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext }
      • Optional navigate?: Navigate
      • Optional nextFactorOptions?: string[]
      • Optional redirectBack?: boolean
      • Optional stepUp?: boolean
      • Optional userContext?: UserContext

    Returns Promise<void>

resyncSessionAndFetchMFAInfo

  • resyncSessionAndFetchMFAInfo(input?: { options?: RecipeFunctionOptions; userContext?: UserContext }): Promise<{ emails: Record<string, undefined | string[]>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, undefined | string[]>; status: "OK" }>

  • Parameters

    • Optional input: { options?: RecipeFunctionOptions; userContext?: UserContext }
      • Optional options?: RecipeFunctionOptions
      • Optional userContext?: UserContext

    Returns Promise<{ emails: Record<string, undefined | string[]>; factors: MFAFactorInfo; fetchResponse: Response; phoneNumbers: Record<string, undefined | string[]>; status: "OK" }>

Generated using TypeDoc