MFA

Classes

default

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

Constructors

Constructor

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
ComponentsOverrideProvider	static	any	RecipeComponentsOverrideContextProvider	recipe/multifactorauth/index.ts:96
FactorIds	static	object	FactorIds	recipe/multifactorauth/index.ts:34
FactorIds.EMAILPASSWORD	readonly	"emailpassword"	"emailpassword"	recipe/multifactorauth/types.ts:132
FactorIds.LINK_EMAIL	readonly	"link-email"	"link-email"	recipe/multifactorauth/types.ts:135
FactorIds.LINK_PHONE	readonly	"link-phone"	"link-phone"	recipe/multifactorauth/types.ts:136
FactorIds.OTP_EMAIL	readonly	"otp-email"	"otp-email"	recipe/multifactorauth/types.ts:133
FactorIds.OTP_PHONE	readonly	"otp-phone"	"otp-phone"	recipe/multifactorauth/types.ts:134
FactorIds.THIRDPARTY	readonly	"thirdparty"	"thirdparty"	recipe/multifactorauth/types.ts:137
FactorIds.TOTP	readonly	"totp"	"totp"	recipe/multifactorauth/types.ts:138
FactorIds.WEBAUTHN	readonly	"webauthn"	"webauthn"	recipe/multifactorauth/types.ts:139
MultiFactorAuthClaim	static	any	MultiFactorAuthRecipe.MultiFactorAuthClaim	recipe/multifactorauth/index.ts:33

Methods

getSecondaryFactors()

static getSecondaryFactors(input): any;

Defined in: recipe/multifactorauth/index.ts:90

Parameters

Parameter	Type
input	{ userContext?: UserContext; }
input.userContext?	UserContext

Returns

any

init()

static init(config?): any;

Defined in: recipe/multifactorauth/index.ts:36

Parameters

Parameter	Type
config?	UserInput

Returns

any

redirectToFactor()

static redirectToFactor(input): any;

Defined in: recipe/multifactorauth/index.ts:56

Parameters

Parameter	Type
input	{ factorId: string; forceSetup?: boolean; navigate?: Navigate; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext; }
input.factorId	string
input.forceSetup?	boolean
input.navigate?	Navigate
input.redirectBack?	boolean
input.stepUp?	boolean
input.userContext?	UserContext

Returns

any

redirectToFactorChooser()

static redirectToFactorChooser(input): any;

Defined in: recipe/multifactorauth/index.ts:74

Parameters

Parameter	Type
input	{ navigate?: Navigate; nextFactorOptions?: string[]; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext; }
input.navigate?	Navigate
input.nextFactorOptions?	string[]
input.redirectBack?	boolean
input.stepUp?	boolean
input.userContext?	UserContext

Returns

any

resyncSessionAndFetchMFAInfo()

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

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

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

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

Variables

getSecondaryFactors()

const getSecondaryFactors: (input) => any = Wrapper.getSecondaryFactors;

Defined in: recipe/multifactorauth/index.ts:103

Parameters

Parameter	Type
input	{ userContext?: UserContext; }
input.userContext?	UserContext

Returns

any

init()

const init: (config?) => any = Wrapper.init;

Defined in: recipe/multifactorauth/index.ts:99

Parameters

Parameter	Type
config?	UserInput

Returns

any

MultiFactorAuthClaim

const MultiFactorAuthClaim: any = MultiFactorAuthRecipe.MultiFactorAuthClaim;

Defined in: recipe/multifactorauth/index.ts:105

MultiFactorAuthComponentsOverrideProvider

const MultiFactorAuthComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/multifactorauth/index.ts:104

redirectToFactor()

const redirectToFactor: (input) => any = Wrapper.redirectToFactor;

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

Parameters

Parameter	Type
input	{ factorId: string; forceSetup?: boolean; navigate?: Navigate; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext; }
input.factorId	string
input.forceSetup?	boolean
input.navigate?	Navigate
input.redirectBack?	boolean
input.stepUp?	boolean
input.userContext?	UserContext

Returns

any

redirectToFactorChooser()

const redirectToFactorChooser: (input) => any = Wrapper.redirectToFactorChooser;

Defined in: recipe/multifactorauth/index.ts:102

Parameters

Parameter	Type
input	{ navigate?: Navigate; nextFactorOptions?: string[]; redirectBack?: boolean; stepUp?: boolean; userContext?: UserContext; }
input.navigate?	Navigate
input.nextFactorOptions?	string[]
input.redirectBack?	boolean
input.stepUp?	boolean
input.userContext?	UserContext

Returns

any

resyncSessionAndFetchMFAInfo()

const resyncSessionAndFetchMFAInfo: (input?) => Promise<{
  emails: Record<string, string[] | undefined>;
  factors: MFAFactorInfo;
  fetchResponse: Response;
  phoneNumbers: Record<string, string[] | undefined>;
  status: "OK";
}> = Wrapper.resyncSessionAndFetchMFAInfo;

Defined in: recipe/multifactorauth/index.ts:100

Parameters

Parameter	Type
input?	{ options?: RecipeFunctionOptions; userContext?: UserContext; }
input.options?	RecipeFunctionOptions
input.userContext?	UserContext

Returns

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

References

FactorIds

Re-exports FactorIds

GetRedirectionURLContext

Re-exports GetRedirectionURLContext

OnHandleEventContext

Re-exports OnHandleEventContext

PreAPIHookContext

Re-exports PreAPIHookContext

RecipeInterface

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput