MFA Types

Type Aliases

APIInterface

type APIInterface = object;

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

Properties

Property	Type	Defined in
resyncSessionAndFetchMFAInfoPUT	| undefined | (input) => Promise< | { emails: Record<string, string[] | undefined>; factors: { allowedToSetup: string[]; alreadySetup: string[]; next: string[]; }; phoneNumbers: Record<string, string[] | undefined>; status: "OK"; } | GeneralErrorResponse>	recipe/multifactorauth/types.ts:119

APIOptions

type APIOptions = object;

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

Properties

Property	Type	Defined in
config	TypeNormalisedInput	recipe/multifactorauth/types.ts:111
isInServerlessEnv	boolean	recipe/multifactorauth/types.ts:113
recipeId	string	recipe/multifactorauth/types.ts:112
recipeImplementation	RecipeInterface	recipe/multifactorauth/types.ts:109
recipeInstance	Recipe	recipe/multifactorauth/types.ts:110
req	BaseRequest	recipe/multifactorauth/types.ts:114
res	BaseResponse	recipe/multifactorauth/types.ts:115

GetAllAvailableSecondaryFactorIdsFromOtherRecipesFunc()

type GetAllAvailableSecondaryFactorIdsFromOtherRecipesFunc = (tenantConfig) => string[];

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

Parameters

Parameter	Type
tenantConfig	TenantConfig

Returns

string[]

GetEmailsForFactorFromOtherRecipesFunc()

type GetEmailsForFactorFromOtherRecipesFunc = (user, sessionRecipeUserId) => 
  | {
  factorIdToEmailsMap: Record<string, string[]>;
  status: "OK";
}
  | {
  status: "UNKNOWN_SESSION_RECIPE_USER_ID";
};

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

Parameters

Parameter	Type
user	User
sessionRecipeUserId	RecipeUserId

Returns

| { factorIdToEmailsMap: Record<string, string[]>; status: "OK"; } | { status: "UNKNOWN_SESSION_RECIPE_USER_ID"; }

GetFactorsSetupForUserFromOtherRecipesFunc()

type GetFactorsSetupForUserFromOtherRecipesFunc = (user, userContext) => Promise<string[]>;

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

Parameters

Parameter	Type
user	User
userContext	UserContext

Returns

Promise<string[]>

GetPhoneNumbersForFactorsFromOtherRecipesFunc()

type GetPhoneNumbersForFactorsFromOtherRecipesFunc = (user, sessionRecipeUserId) => 
  | {
  factorIdToPhoneNumberMap: Record<string, string[]>;
  status: "OK";
}
  | {
  status: "UNKNOWN_SESSION_RECIPE_USER_ID";
};

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

Parameters

Parameter	Type
user	User
sessionRecipeUserId	RecipeUserId

Returns

| { factorIdToPhoneNumberMap: Record<string, string[]>; status: "OK"; } | { status: "UNKNOWN_SESSION_RECIPE_USER_ID"; }

MFAClaimValue

type MFAClaimValue = object;

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

Properties

Property	Type	Defined in
c	Record<string, number | undefined>	recipe/multifactorauth/types.ts:37
v	boolean	recipe/multifactorauth/types.ts:38

MFARequirementList

type MFARequirementList = (
  | {
  oneOf: string[];
}
  | {
  allOfInAnyOrder: string[];
}
  | string)[];

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

RecipeInterface

type RecipeInterface = object;

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

Properties

Property	Type	Defined in
addToRequiredSecondaryFactorsForUser	(input) => Promise<void>	recipe/multifactorauth/types.ts:95
assertAllowedToSetupFactorElseThrowInvalidClaimError	(input) => Promise<void>	recipe/multifactorauth/types.ts:66
getFactorsSetupForUser	(input) => Promise<string[]>	recipe/multifactorauth/types.ts:91
getMFARequirementsForAuth	(input) => | Promise<MFARequirementList> | MFARequirementList	recipe/multifactorauth/types.ts:74
getRequiredSecondaryFactorsForUser	(input) => Promise<string[]>	recipe/multifactorauth/types.ts:93
markFactorAsCompleteInSession	(input) => Promise<void>	recipe/multifactorauth/types.ts:85
removeFromRequiredSecondaryFactorsForUser	(input) => Promise<void>	recipe/multifactorauth/types.ts:101

TypeInput

type TypeInput = object;

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

Properties

Property	Type	Defined in
firstFactors?	string[]	recipe/multifactorauth/types.ts:42
override?	object	recipe/multifactorauth/types.ts:44
override.apis?	(originalImplementation, builder) => APIInterface	recipe/multifactorauth/types.ts:49
override.functions?	(originalImplementation, builder) => RecipeInterface	recipe/multifactorauth/types.ts:45

TypeNormalisedInput

type TypeNormalisedInput = object;

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

Properties

Property	Type	Defined in
firstFactors?	string[]	recipe/multifactorauth/types.ts:54
override	object	recipe/multifactorauth/types.ts:56
override.apis	(originalImplementation, builder) => APIInterface	recipe/multifactorauth/types.ts:61
override.functions	(originalImplementation, builder) => RecipeInterface	recipe/multifactorauth/types.ts:57

Variables

FactorIds

const FactorIds: object;

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

Type Declaration

Name	Type	Default value	Defined in
EMAILPASSWORD	string	"emailpassword"	recipe/multifactorauth/types.ts:152
LINK_EMAIL	string	"link-email"	recipe/multifactorauth/types.ts:156
LINK_PHONE	string	"link-phone"	recipe/multifactorauth/types.ts:157
OTP_EMAIL	string	"otp-email"	recipe/multifactorauth/types.ts:154
OTP_PHONE	string	"otp-phone"	recipe/multifactorauth/types.ts:155
THIRDPARTY	string	"thirdparty"	recipe/multifactorauth/types.ts:158
TOTP	string	"totp"	recipe/multifactorauth/types.ts:159
WEBAUTHN	string	"webauthn"	recipe/multifactorauth/types.ts:153