Get the current MFA status | Docmost Octri Preview

2 status codes

200Returns the MFA status in the successful response envelope, with the result in `data` and `status` and `success` fields.

dataobjectoptional

statusintegeroptional

successbooleanoptional

401Returned when the request is unauthorized.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

A 401 is returned when the request is unauthorized; send valid authentication credentials to retrieve MFA status.

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.mfa.status();

{
  "data": {
    "backupCodesCount": 42,
    "isEnabled": true,
    "method": "example_value"
  },
  "status": 200,
  "success": true
}

Response

Errors