Skip to content
patch

Create MFA Recovery Codes

Endpoint

patchhttps://<REGION>.cloud.appwrite.io/v1/users/{userId}/mfa/recovery-codes

Description

Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in createMfaChallenge method by client SDK.

Required scopes

users.write

Authentication

Initialize the Appwrite client with setProject() and a server API key (setKey()). For direct REST calls, send X-Appwrite-Project and X-Appwrite-Key.

Path

string
Required

User ID.

Status
Content type
201
application/json

MFA Recovery Codes

Name
Type
Description
arrayof string

Recovery codes.

JavaScript
import { Client, Users } from "https://deno.land/x/appwrite/mod.ts";


const client = new Client()
    .setEndpoint('https://cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>') // Your project ID
    .setKey('<YOUR_API_KEY>'); // Your secret API key


const users = new Users(client);


const response = await users.createMfaRecoveryCodes(
    '<USER_ID>' // userId
);