supertokens-auth-react/recipe/multifactorauth

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

new default(): default;

Properties

Property	Modifier	Type	Default value	Defined in
`ComponentsOverrideProvider`	`static`	`any`	`RecipeComponentsOverrideContextProvider`	recipe/multifactorauth/index.ts
`FactorIds`	`static`	`object`	`FactorIds`	recipe/multifactorauth/index.ts
`FactorIds.EMAILPASSWORD`	`readonly`	`"emailpassword"`	`"emailpassword"`	recipe/multifactorauth/types.ts
`FactorIds.LINK_EMAIL`	`readonly`	`"link-email"`	`"link-email"`	recipe/multifactorauth/types.ts
`FactorIds.LINK_PHONE`	`readonly`	`"link-phone"`	`"link-phone"`	recipe/multifactorauth/types.ts
`FactorIds.OTP_EMAIL`	`readonly`	`"otp-email"`	`"otp-email"`	recipe/multifactorauth/types.ts
`FactorIds.OTP_PHONE`	`readonly`	`"otp-phone"`	`"otp-phone"`	recipe/multifactorauth/types.ts
`FactorIds.THIRDPARTY`	`readonly`	`"thirdparty"`	`"thirdparty"`	recipe/multifactorauth/types.ts
`FactorIds.TOTP`	`readonly`	`"totp"`	`"totp"`	recipe/multifactorauth/types.ts
`FactorIds.WEBAUTHN`	`readonly`	`"webauthn"`	`"webauthn"`	recipe/multifactorauth/types.ts
`MultiFactorAuthClaim`	`static`	`any`	`MultiFactorAuthRecipe.MultiFactorAuthClaim`	recipe/multifactorauth/index.ts

Methods

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

Parameters

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

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

Parameters

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

Returns

any

init()

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

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`config?`	`UserInput`

Returns

any

MultiFactorAuthClaim

const MultiFactorAuthClaim: any = MultiFactorAuthRecipe.MultiFactorAuthClaim;

Defined in: recipe/multifactorauth/index.ts

MultiFactorAuthComponentsOverrideProvider

const MultiFactorAuthComponentsOverrideProvider: any = Wrapper.ComponentsOverrideProvider;

Defined in: recipe/multifactorauth/index.ts

redirectToFactor()

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

Defined in: recipe/multifactorauth/index.ts

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

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

Parameters

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

Returns

References

FactorIds

Re-exports FactorIds

RecipeInterface

Renames and re-exports SuperTokensWrapper

UserInput

Re-exports UserInput