Interface MfaClient

MFA client interface available in both server and client contexts.

interface MfaClient {
    challenge(
        options: {
            authenticatorId?: string;
            challengeType: string;
            mfaToken: string;
        },
    ): Promise<ChallengeResponse>;
    enroll(options: EnrollOptions): Promise<EnrollmentResponse>;
    getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>;
    verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>;
}

Index

Methods

challenge enroll getAuthenticators verify

Methods

challenge

challenge(
    options: {
        authenticatorId?: string;
        challengeType: string;
        mfaToken: string;
    },
): Promise<ChallengeResponse>
Initiate an MFA challenge.
Parameters
- options: { authenticatorId?: string; challengeType: string; mfaToken: string }
  Challenge options
Returns Promise<ChallengeResponse>
Challenge response (oobCode, bindingMethod)
- Defined in src/types/mfa.ts:310

enroll

enroll(options: EnrollOptions): Promise<EnrollmentResponse>
Enroll a new MFA authenticator during initial MFA setup.
Parameters
- options: EnrollOptions
  Enrollment options (otp | oob | email)
Returns Promise<EnrollmentResponse>
Enrollment response with authenticator details and optional recovery codes
- Defined in src/types/mfa.ts:331

getAuthenticators

getAuthenticators(options: { mfaToken: string }): Promise<Authenticator[]>
List enrolled authenticators for the user. Filters by allowed challenge types from mfa_requirements.
Parameters
- options: { mfaToken: string }
  Options containing encrypted mfaToken
Returns Promise<Authenticator[]>
Array of authenticators
- Defined in src/types/mfa.ts:302

verify

verify(options: VerifyMfaOptions): Promise<MfaVerifyResponse>
Verify MFA code and complete authentication. Stores the resulting tokens in the session cookie server-side.
Parameters
- options: VerifyMfaOptions
  Verification options (otp | oobCode+bindingCode | recoveryCode)
Returns Promise<MfaVerifyResponse>
{ success: true } — call getAccessToken() afterward to retrieve the token.
- Defined in src/types/mfa.ts:323