Module recipe/multifactorauth

resyncSessionAndFetchMFAInfoPUT: undefined | ((input: { options: APIOptions; session: SessionContainer; userContext: UserContext }) => Promise<{ emails: Record<string, string[] | undefined>; factors: { allowedToSetup: string[]; alreadySetup: string[]; next: string[] }; phoneNumbers: Record<string, string[] | undefined>; status: "OK" } | GeneralErrorResponse>)

config: TypeNormalisedInput

isInServerlessEnv: boolean

recipeId: string

recipeImplementation: RecipeInterface

recipeInstance: Recipe

req: BaseRequest

res: BaseResponse

addToRequiredSecondaryFactorsForUser:function

• addToRequiredSecondaryFactorsForUser(input: { factorId: string; userContext: UserContext; userId: string }): Promise<void>

• Parameters

  • input: { factorId: string; userContext: UserContext; userId: string }

    • factorId: string

    • userContext: UserContext

    • userId: string

  Returns Promise<void>

assertAllowedToSetupFactorElseThrowInvalidClaimError:function

• assertAllowedToSetupFactorElseThrowInvalidClaimError(input: { factorId: string; factorsSetUpForUser: Promise<string[]>; mfaRequirementsForAuth: Promise<MFARequirementList>; session: SessionContainer; userContext: UserContext }): Promise<void>

• Parameters

  • input: { factorId: string; factorsSetUpForUser: Promise<string[]>; mfaRequirementsForAuth: Promise<MFARequirementList>; session: SessionContainer; userContext: UserContext }

    • factorId: string

    • factorsSetUpForUser: Promise<string[]>

    • mfaRequirementsForAuth: Promise<MFARequirementList>

    • session: SessionContainer

    • userContext: UserContext

  Returns Promise<void>

getFactorsSetupForUser:function

• getFactorsSetupForUser(input: { user: User; userContext: UserContext }): Promise<string[]>

• Parameters

  • input: { user: User; userContext: UserContext }

    • user: User

    • userContext: UserContext

  Returns Promise<string[]>

getMFARequirementsForAuth:function

• getMFARequirementsForAuth(input: { accessTokenPayload: JSONObject; completedFactors: MFAClaimValue["c"]; factorsSetUpForUser: Promise<string[]>; requiredSecondaryFactorsForTenant: Promise<string[]>; requiredSecondaryFactorsForUser: Promise<string[]>; tenantId: string; user: Promise<User>; userContext: UserContext }): MFARequirementList | Promise<MFARequirementList>

• Parameters

  • input: { accessTokenPayload: JSONObject; completedFactors: MFAClaimValue["c"]; factorsSetUpForUser: Promise<string[]>; requiredSecondaryFactorsForTenant: Promise<string[]>; requiredSecondaryFactorsForUser: Promise<string[]>; tenantId: string; user: Promise<User>; userContext: UserContext }

    • accessTokenPayload: JSONObject

    • completedFactors: MFAClaimValue["c"]

    • factorsSetUpForUser: Promise<string[]>

    • requiredSecondaryFactorsForTenant: Promise<string[]>

    • requiredSecondaryFactorsForUser: Promise<string[]>

    • tenantId: string

    • user: Promise<User>

    • userContext: UserContext

  Returns MFARequirementList | Promise<MFARequirementList>

getRequiredSecondaryFactorsForUser:function

• getRequiredSecondaryFactorsForUser(input: { userContext: UserContext; userId: string }): Promise<string[]>

• Parameters

  • input: { userContext: UserContext; userId: string }

    • userContext: UserContext

    • userId: string

  Returns Promise<string[]>

markFactorAsCompleteInSession:function

• markFactorAsCompleteInSession(input: { factorId: string; session: SessionContainer; userContext: UserContext }): Promise<void>

• Parameters

  • input: { factorId: string; session: SessionContainer; userContext: UserContext }

    • factorId: string

    • session: SessionContainer

    • userContext: UserContext

  Returns Promise<void>

removeFromRequiredSecondaryFactorsForUser:function

• removeFromRequiredSecondaryFactorsForUser(input: { factorId: string; userContext: UserContext; userId: string }): Promise<void>

• Parameters

  • input: { factorId: string; userContext: UserContext; userId: string }

    • factorId: string

    • userContext: UserContext

    • userId: string

  Returns Promise<void>