Skip to main content

IQMFAPolicyEngine

@quik/mfa

@quik/mfa / IQMFAPolicyEngine

Interface: IQMFAPolicyEngine

Defined in: mfa/src/types.ts:101

Pluggable MFA policy engine contract.

Methods​

evaluateRisk()?​

optional evaluateRisk(input): number | Promise<number>

Defined in: mfa/src/types.ts:107

Returns an optional risk score for one verify attempt.

Parameters​

input​

QMFAVerifyInput | Partial<QMFAVerifyInput>

Returns​

number | Promise<number>

resolveRequest()?​

optional resolveRequest(input): void | QMFARequestInput | Partial<QMFARequestInput> | Promise<void | QMFARequestInput | Partial<QMFARequestInput>>

Defined in: mfa/src/types.ts:103

Resolves policy-adjusted request values before challenge creation.

Parameters​

input​

QMFAPolicyResolveRequestInput | Partial<QMFAPolicyResolveRequestInput>

Returns​

void | QMFARequestInput | Partial<QMFARequestInput> | Promise<void | QMFARequestInput | Partial<QMFARequestInput>>

resolveStepUp()?​

optional resolveStepUp(input): void | QMFAStepUpRequirement | Partial<QMFAStepUpRequirement> | Promise<void | QMFAStepUpRequirement | Partial<QMFAStepUpRequirement>>

Defined in: mfa/src/types.ts:109

Returns an optional step-up requirement for one verify attempt.

Parameters​

input​

QMFAPolicyResolveStepUpInput | Partial<QMFAPolicyResolveStepUpInput>

Returns​

void | QMFAStepUpRequirement | Partial<QMFAStepUpRequirement> | Promise<void | QMFAStepUpRequirement | Partial<QMFAStepUpRequirement>>