Skip to main content

SecondFactorParameters

@webda/auth


Class: SecondFactorParameters

Defined in: packages/auth/src/mfa/secondfactor.service.ts:11

Parameters common to all second factor services

Extends​

  • ServiceParameters

Extended by​

Constructors​

Constructor​

new SecondFactorParameters(): SecondFactorParameters

Returns​

SecondFactorParameters

Inherited from​

ServiceParameters.constructor

Properties​

recoveryCodes​

recoveryCodes: number = 10

Defined in: packages/auth/src/mfa/secondfactor.service.ts:15

Number of recovery codes generated (default 10, 0 disables recovery codes)


throttle​

throttle: ThrottleParameters

Defined in: packages/auth/src/mfa/secondfactor.service.ts:13

Throttle config for failed attempts


type​

type: string

Defined in: packages/core/lib/services/serviceparameters.d.ts:9

Type of the service

Inherited from​

ServiceParameters.type

Methods​

load()​

load(params?): this

Defined in: packages/core/lib/application/parameters.d.ts:14

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any

the service parameters

Returns​

this

this for chaining

Inherited from​

ServiceParameters.load


update()​

update(params, delta): this

Defined in: packages/core/lib/application/parameters.d.ts:21

Update parameters and call watchers if a parameter was changed

Parameters​

params​

any

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update


with()​

with(callback): this

Defined in: packages/core/lib/application/parameters.d.ts:27

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with