MFA Types

Type Aliases

ComponentOverrideMap

type ComponentOverrideMap = object;

Defined in: recipe/multifactorauth/types.ts:32

Properties

Property	Type	Defined in
MFAFactorChooserFooter_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/multifactorauth/types.ts:33
MFAFactorChooserHeader_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/multifactorauth/types.ts:34
MFAFactorList_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/multifactorauth/types.ts:35
MFAFactorOption_Override?	ComponentOverride<typeof SuperTokensWrapper>	recipe/multifactorauth/types.ts:36

Config

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

Defined in: recipe/multifactorauth/types.ts:58

FactorChooserThemeProps

type FactorChooserThemeProps = object;

Defined in: recipe/multifactorauth/types.ts:112

Properties

Property	Type	Defined in
availableFactors	SecondaryFactorRedirectionInfo[]	recipe/multifactorauth/types.ts:114
config	NormalisedConfig	recipe/multifactorauth/types.ts:119
mfaInfo	LoadedMFAInfo	recipe/multifactorauth/types.ts:113
navigateToFactor	(factorId) => void	recipe/multifactorauth/types.ts:117
onBackButtonClicked	() => void	recipe/multifactorauth/types.ts:116
onLogoutClicked	() => void	recipe/multifactorauth/types.ts:118
showBackButton	boolean	recipe/multifactorauth/types.ts:115
userContext?	UserContext	recipe/multifactorauth/types.ts:120

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:78

LoadedMFAInfo

type LoadedMFAInfo = object;

Defined in: recipe/multifactorauth/types.ts:106

Properties

Property	Type	Defined in
emails	Record<string, string[] | undefined>	recipe/multifactorauth/types.ts:108
factors	SuperTokensWrapper	recipe/multifactorauth/types.ts:107
phoneNumbers	Record<string, string[] | undefined>	recipe/multifactorauth/types.ts:109

NormalisedConfig

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

Defined in: recipe/multifactorauth/types.ts:61

Type Declaration

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

OnHandleEventContext

type OnHandleEventContext = object;

Defined in: recipe/multifactorauth/types.ts:101

Properties

Property	Type	Defined in
action	"FACTOR_CHOOSEN"	recipe/multifactorauth/types.ts:102
factorId	string	recipe/multifactorauth/types.ts:103

PreAndPostAPIHookAction

type PreAndPostAPIHookAction = "GET_MFA_INFO";

Defined in: recipe/multifactorauth/types.ts:92

PreAPIHookContext

type PreAPIHookContext = object;

Defined in: recipe/multifactorauth/types.ts:94

Properties

Property	Type	Defined in
action	PreAndPostAPIHookAction	recipe/multifactorauth/types.ts:95
requestInit	RequestInit	recipe/multifactorauth/types.ts:96
url	string	recipe/multifactorauth/types.ts:97
userContext	UserContext	recipe/multifactorauth/types.ts:98

SecondaryFactorRedirectionInfo

type SecondaryFactorRedirectionInfo = object;

Defined in: recipe/multifactorauth/types.ts:123

Properties

Property	Type	Defined in
description	string	recipe/multifactorauth/types.ts:126
id	string	recipe/multifactorauth/types.ts:124
logo	FC	recipe/multifactorauth/types.ts:127
name	string	recipe/multifactorauth/types.ts:125
path	string	recipe/multifactorauth/types.ts:128

UserInput

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

Defined in: recipe/multifactorauth/types.ts:40

Type Declaration

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

Variables

FactorIds

const FactorIds: object;

Defined in: recipe/multifactorauth/types.ts:131

Type Declaration

Name	Type	Default value	Defined in
EMAILPASSWORD	"emailpassword"	"emailpassword"	recipe/multifactorauth/types.ts:132
LINK_EMAIL	"link-email"	"link-email"	recipe/multifactorauth/types.ts:135
LINK_PHONE	"link-phone"	"link-phone"	recipe/multifactorauth/types.ts:136
OTP_EMAIL	"otp-email"	"otp-email"	recipe/multifactorauth/types.ts:133
OTP_PHONE	"otp-phone"	"otp-phone"	recipe/multifactorauth/types.ts:134
THIRDPARTY	"thirdparty"	"thirdparty"	recipe/multifactorauth/types.ts:137
TOTP	"totp"	"totp"	recipe/multifactorauth/types.ts:138
WEBAUTHN	"webauthn"	"webauthn"	recipe/multifactorauth/types.ts:139