Class MultiFactorAuthClaimClass

We include "Class" in the class name, because it makes it easier to import/use the right thing (the instance exported by the recipe) instead of this.

Hierarchy

MultiFactorAuthClaimClass

Implements

SessionClaim<MFAClaimValue>

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MultiFactorAuthClaimClass(getRecipeImpl: (() => RecipeInterface)): MultiFactorAuthClaimClass

- Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:15
Parameters
- getRecipeImpl: (() => RecipeInterface)
  - - (): RecipeInterface
    - Returns RecipeInterface
Returns MultiFactorAuthClaimClass

Properties

Protected getRecipeImpl

getRecipeImpl: (() => RecipeInterface)

Type declaration

- (): RecipeInterface
- Returns RecipeInterface

id

id: string = "st-mfa"

validators

validators: { hasCompletedFactors: any; hasCompletedMFARequirementsForAuth: any }

Type declaration

hasCompletedFactors:function
- hasCompletedFactors(requirements: MFARequirementList): SessionClaimValidator
- - Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:12
  Parameters
  - requirements: MFARequirementList
  Returns SessionClaimValidator
hasCompletedMFARequirementsForAuth:function
- hasCompletedMFARequirementsForAuth(): SessionClaimValidator
- - Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:11
  Returns SessionClaimValidator

Methods

getLastFetchedTime

getLastFetchedTime(payload: any, _userContext?: any): undefined | number

Implementation of SessionClaim.getLastFetchedTime
- Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:138
Parameters
- payload: any
- Optional _userContext: any
Returns undefined | number

getValueFromPayload

getValueFromPayload(payload: any, _userContext?: any): undefined | { c: Record<string, undefined | number>; v: boolean }

Implementation of SessionClaim.getValueFromPayload
- Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:124
Parameters
- payload: any
- Optional _userContext: any
Returns undefined | { c: Record<string, undefined | number>; v: boolean }

refresh

refresh(userContext: any): Promise<void>

Implementation of SessionClaim.refresh
- Defined in lib/ts/recipe/multifactorauth/multiFactorAuthClaim.ts:120
Parameters
- userContext: any
Returns Promise<void>

Generated using TypeDoc