Get your current multi factor auth status

GET/v2/users/self/credentials/mfa/

API version

v2

Request method

GET

Operation ID

user-get-mfa-status

---

Request

No request parameters.

Responses

Format

application/json

Description

Multi factor auth status

Schema documentation

• confirmedboolean

  required
• initializedboolean

  required

Example

Content-Type: application/json

{
  "confirmed": true,
  "initialized": true
}

JSON Schema

{
  "properties": {
    "confirmed": {
      "type": "boolean"
    },
    "initialized": {
      "type": "boolean"
    }
  },
  "required": [
    "initialized",
    "confirmed"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v2/users/self/credentials/mfa

JavaScript SDK

import { MittwaldAPIV2Client } from "@mittwald/api-client";
import { assertStatus } from "@mittwald/api-client-commons";
  
const client = MittwaldAPIClient.newWithToken(process.env.MITTWALD_API_TOKEN);
const response = await client.user.getMfaStatus({});

assertStatus(response, 200);
  

PHP SDK

use \Mittwald\ApiClient\Generated\V2\Clients\User\GetMfaStatus\GetMfaStatusRequest;
  
$client = MittwaldAPIClient::newWithToken(getenv('MITTWALD_API_TOKEN'));

$request = (new GetMfaStatusRequest());
$response = $client->user()->getMfaStatus($request);

var_dump($response->getBody();