supertokens-node/recipe/multifactorauth

References documentation for the supertokens-node/recipe/multifactorauth package

new default(): default;

Returns

default

Properties

Property	Modifier	Type	Default value	Defined in
`FactorIds`	`static`	`object`	`FactorIds`	recipe/multifactorauth/index.ts
`FactorIds.EMAILPASSWORD`	`public`	`string`	`"emailpassword"`	recipe/multifactorauth/types.ts
`FactorIds.LINK_EMAIL`	`public`	`string`	`"link-email"`	recipe/multifactorauth/types.ts
`FactorIds.LINK_PHONE`	`public`	`string`	`"link-phone"`	recipe/multifactorauth/types.ts
`FactorIds.OTP_EMAIL`	`public`	`string`	`"otp-email"`	recipe/multifactorauth/types.ts
`FactorIds.OTP_PHONE`	`public`	`string`	`"otp-phone"`	recipe/multifactorauth/types.ts
`FactorIds.THIRDPARTY`	`public`	`string`	`"thirdparty"`	recipe/multifactorauth/types.ts
`FactorIds.TOTP`	`public`	`string`	`"totp"`	recipe/multifactorauth/types.ts
`FactorIds.WEBAUTHN`	`public`	`string`	`"webauthn"`	recipe/multifactorauth/types.ts
`init`	`static`	(`config?`) => `RecipeListFunction`	`Recipe.init`	recipe/multifactorauth/index.ts
`MultiFactorAuthClaim`	`static`	`MultiFactorAuthClaimClass`	`MultiFactorAuthClaim`	recipe/multifactorauth/index.ts

Methods

addToRequiredSecondaryFactorsForUser()

static addToRequiredSecondaryFactorsForUser(
   userId, 
   factorId, 
userContext?): Promise<void>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

assertAllowedToSetupFactorElseThrowInvalidClaimError()

static assertAllowedToSetupFactorElseThrowInvalidClaimError(
   session, 
   factorId, 
userContext?): Promise<void>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

getFactorsSetupForUser()

static getFactorsSetupForUser(userId, userContext?): Promise<string[]>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<string[]>

getMFARequirementsForAuth()

static getMFARequirementsForAuth(session, userContext?): Promise<MFARequirementList>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<MFARequirementList>

getRequiredSecondaryFactorsForUser()

static getRequiredSecondaryFactorsForUser(userId, userContext?): Promise<string[]>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<string[]>

markFactorAsCompleteInSession()

static markFactorAsCompleteInSession(
   session, 
   factorId, 
userContext?): Promise<void>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

removeFromRequiredSecondaryFactorsForUser()

static removeFromRequiredSecondaryFactorsForUser(
   userId, 
   factorId, 
userContext?): Promise<void>;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

Variables

addToRequiredSecondaryFactorsForUser()

const addToRequiredSecondaryFactorsForUser: (userId, factorId, userContext?) => Promise<void> = Wrapper.addToRequiredSecondaryFactorsForUser;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

assertAllowedToSetupFactorElseThrowInvalidClaimError()

assertAllowedToSetupFactorElseThrowInvalidClaimError: (session, factorId, userContext?) => Promise<void> = Wrapper.assertAllowedToSetupFactorElseThrowInvalidClaimError;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

getFactorsSetupForUser()

getFactorsSetupForUser: (userId, userContext?) => Promise<string[]> = Wrapper.getFactorsSetupForUser;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<string[]>

getMFARequirementsForAuth()

getMFARequirementsForAuth: (session, userContext?) => Promise<MFARequirementList> = Wrapper.getMFARequirementsForAuth;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<MFARequirementList>

getRequiredSecondaryFactorsForUser()

getRequiredSecondaryFactorsForUser: (userId, userContext?) => Promise<string[]> = Wrapper.getRequiredSecondaryFactorsForUser;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<string[]>

init()

init: (config?) => RecipeListFunction = Wrapper.init;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`config?`	`TypeInput`

Returns

RecipeListFunction

markFactorAsCompleteInSession()

markFactorAsCompleteInSession: (session, factorId, userContext?) => Promise<void> = Wrapper.markFactorAsCompleteInSession;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`session`	`SessionContainerInterface`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

MultiFactorAuthClaim

const MultiFactorAuthClaim: MultiFactorAuthClaimClass;

Defined in: recipe/multifactorauth/multiFactorAuthClaim.ts

removeFromRequiredSecondaryFactorsForUser()

const removeFromRequiredSecondaryFactorsForUser: (userId, factorId, userContext?) => Promise<void> = Wrapper.removeFromRequiredSecondaryFactorsForUser;

Defined in: recipe/multifactorauth/index.ts

Parameters

Parameter	Type
`userId`	`string`
`factorId`	`string`
`userContext?`	`Record`<`string`, `any`>

Returns

Promise<void>

References

APIInterface

Re-exports APIInterface

APIOptions

Re-exports APIOptions

FactorIds

Re-exports FactorIds

RecipeInterface

Re-exports RecipeInterface