supertokens-auth-react/recipe/multifactorauth/types

References documentation for the supertokens-auth-react/recipe/multifactorauth/types package

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`MFAFactorChooserFooter_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/multifactorauth/types.ts
`MFAFactorChooserHeader_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/multifactorauth/types.ts
`MFAFactorList_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/multifactorauth/types.ts
`MFAFactorOption_Override?`	`ComponentOverride`<typeof `SuperTokensWrapper`>	recipe/multifactorauth/types.ts

Config

type Config = UserInput & RecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/multifactorauth/types.ts

FactorChooserThemeProps

type FactorChooserThemeProps = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`availableFactors`	`SecondaryFactorRedirectionInfo`[]	recipe/multifactorauth/types.ts
`config`	`NormalisedConfig`	recipe/multifactorauth/types.ts
`mfaInfo`	`LoadedMFAInfo`	recipe/multifactorauth/types.ts
`navigateToFactor`	(`factorId`) => `void`	recipe/multifactorauth/types.ts
`onBackButtonClicked`	() => `void`	recipe/multifactorauth/types.ts
`onLogoutClicked`	() => `void`	recipe/multifactorauth/types.ts
`showBackButton`	`boolean`	recipe/multifactorauth/types.ts
`userContext?`	`UserContext`	recipe/multifactorauth/types.ts

GetRedirectionURLContext

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

Defined in: recipe/multifactorauth/types.ts

LoadedMFAInfo

type LoadedMFAInfo = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`emails`	`Record`<`string`, `string`[] \| `undefined`>	recipe/multifactorauth/types.ts
`factors`	`SuperTokensWrapper`	recipe/multifactorauth/types.ts
`phoneNumbers`	`Record`<`string`, `string`[] \| `undefined`>	recipe/multifactorauth/types.ts

NormalisedConfig

type NormalisedConfig = object & NormalisedRecipeModuleConfig<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/multifactorauth/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI`	`boolean`	recipe/multifactorauth/types.ts
`factorChooserScreen`	`FeatureBaseConfig`	recipe/multifactorauth/types.ts
`firstFactors?`	`string`[]	recipe/multifactorauth/types.ts
`getSecondaryFactorInfo()`	(`builtInFactors`, `userContext`) => `SecondaryFactorRedirectionInfo`[]	recipe/multifactorauth/types.ts
`override`	`object`	recipe/multifactorauth/types.ts
`override.functions()`	(`originalImplementation`, `builder?`) => `SuperTokensWrapper`	recipe/multifactorauth/types.ts

OnHandleEventContext

type OnHandleEventContext = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`action`	`"FACTOR_CHOOSEN"`	recipe/multifactorauth/types.ts
`factorId`	`string`	recipe/multifactorauth/types.ts

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = "GET_MFA_INFO";

Defined in: recipe/multifactorauth/types.ts

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`action`	`PreAndPostAPIHookAction`	recipe/multifactorauth/types.ts
`requestInit`	`RequestInit`	recipe/multifactorauth/types.ts
`url`	`string`	recipe/multifactorauth/types.ts
`userContext`	`UserContext`	recipe/multifactorauth/types.ts

SecondaryFactorRedirectionInfo

type SecondaryFactorRedirectionInfo = object;

Defined in: recipe/multifactorauth/types.ts

Properties

Property	Type	Defined in
`description`	`string`	recipe/multifactorauth/types.ts
`id`	`string`	recipe/multifactorauth/types.ts
`logo`	`FC`	recipe/multifactorauth/types.ts
`name`	`string`	recipe/multifactorauth/types.ts
`path`	`string`	recipe/multifactorauth/types.ts

UserInput

type UserInput = object & RecipeModuleUserInput<GetRedirectionURLContext, PreAndPostAPIHookAction, OnHandleEventContext>;

Defined in: recipe/multifactorauth/types.ts

Type Declaration

Name	Type	Defined in
`disableDefaultUI?`	`boolean`	recipe/multifactorauth/types.ts
`factorChooserScreen?`	`FeatureBaseConfig`	recipe/multifactorauth/types.ts
`firstFactors?`	`string`[]	recipe/multifactorauth/types.ts
`getSecondaryFactorInfo()?`	(`builtInFactors`, `userContext`) => `SecondaryFactorRedirectionInfo`[]	recipe/multifactorauth/types.ts
`override?`	`object`	recipe/multifactorauth/types.ts
`override.functions()?`	(`originalImplementation`, `builder?`) => `SuperTokensWrapper`	recipe/multifactorauth/types.ts

Variables

FactorIds

const FactorIds: object;

Defined in: recipe/multifactorauth/types.ts

Type Declaration

Name	Type	Default value	Defined in
`EMAILPASSWORD`	`"emailpassword"`	`"emailpassword"`	recipe/multifactorauth/types.ts
`LINK_EMAIL`	`"link-email"`	`"link-email"`	recipe/multifactorauth/types.ts
`LINK_PHONE`	`"link-phone"`	`"link-phone"`	recipe/multifactorauth/types.ts
`OTP_EMAIL`	`"otp-email"`	`"otp-email"`	recipe/multifactorauth/types.ts
`OTP_PHONE`	`"otp-phone"`	`"otp-phone"`	recipe/multifactorauth/types.ts
`THIRDPARTY`	`"thirdparty"`	`"thirdparty"`	recipe/multifactorauth/types.ts
`TOTP`	`"totp"`	`"totp"`	recipe/multifactorauth/types.ts
`WEBAUTHN`	`"webauthn"`	`"webauthn"`	recipe/multifactorauth/types.ts