Skip to main content

IQMFAFactor

@quik/mfa


@quik/mfa / IQMFAFactor

Interface: IQMFAFactor

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

Pluggable MFA factor contract.

Properties

method

method: string

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

Method key used to register and resolve the factor.

Methods

issue()

issue(input): Promise<QMFAIssueResult | Partial<QMFAIssueResult> | { challenge: Partial<QMFAChallenge>; }>

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

Creates a challenge for one authentication step.

Parameters

input

QMFAIssueInput | Partial<QMFAIssueInput>

Returns

Promise<QMFAIssueResult | Partial<QMFAIssueResult> | { challenge: Partial<QMFAChallenge>; }>


verify()

verify(input): Promise<boolean>

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

Validates one verification attempt.

Parameters

input

QMFAVerifyInput | Partial<QMFAVerifyInput>

Returns

Promise<boolean>