Skip to main content

MfaParameters

@webda/core

Class: MfaParameters

Defined in: packages/core/src/models/mfa.model.ts:223

Policy for a single MFA attribute.

Extends​

Constructors​

Constructor​

new MfaParameters(): MfaParameters

Returns​

MfaParameters

Inherited from​

Parameters.constructor

Properties​

methods?​

optional methods?: string[]

Defined in: packages/core/src/models/mfa.model.ts:227

Allowed factor methods. Omit to accept all registered methods.

purpose​

purpose: "login" | "step-up" = "step-up"

Defined in: packages/core/src/models/mfa.model.ts:225

Whether this attribute completes login or protects a model operation.

reauthMaxAge​

reauthMaxAge: number = 300

Defined in: packages/core/src/models/mfa.model.ts:233

Maximum primary authentication age for login enrollment, seconds; 0 disables it.

Minimum​

0

recoveryCodes?​

optional recoveryCodes?: number

Defined in: packages/core/src/models/mfa.model.ts:229

Recovery codes issued by this attribute; 0 disables them.

Minimum​

0

verificationMaxAge​

verificationMaxAge: number = MFA_PROOF_TTL

Defined in: packages/core/src/models/mfa.model.ts:231

Verification proof lifetime in seconds.

Minimum​

1

Methods​

load()​

load(params?): this

Defined in: packages/core/src/application/parameters.ts:22

Load raw parameters by assigning them onto this instance

Parameters​

params?​

any = {}

the service parameters

Returns​

this

this for chaining

Inherited from​

Parameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/application/parameters.ts:33

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​

Parameters.update

with()​

with(callback): this

Defined in: packages/core/src/application/parameters.ts:63

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​

Parameters.with