Confirm Multi Factor Authentication

POST/users/self/credentials/mfa/

API version

v2

Request method

POST

Operation ID

user-confirm-mfa

---

Request

Responses

Format

application/json

Description

Mfa is now activated and recovery codes are in the response body.

Schema documentation

• recoveryCodesListarray of string (≥ 16 characters, ≤ 16 characters)

  required
  • Array[
  • *string (≥ 16 characters, ≤ 16 characters)
  ]

Example

Content-Type: application/json

{
  "recoveryCodesList": [
    1234123412341234
  ]
}

JSON Schema

{
  "properties": {
    "recoveryCodesList": {
      "items": {
        "example": 1234123412341234,
        "maxLength": 16,
        "minLength": 16,
        "type": "string"
      },
      "maxItems": 20,
      "minItems": 20,
      "type": "array"
    }
  },
  "required": [
    "recoveryCodesList"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{"multiFactorCode":"123456"}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    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.confirmMfa({
  "data": {
    "multiFactorCode": "123456"
  }
});

assertStatus(response, 200);
  

PHP SDK

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

// TODO: Please consult the properties and constructor signature of
// ConfirmMfaRequestBody to learn how to construct a valid instance
$body = new ConfirmMfaRequestBody(/* TODO: ... */);

$request = (new ConfirmMfaRequest(
  body: $body
));
$response = $client->user()->confirmMfa($request);

var_dump($response->getBody();