Initialize Multi Factor Authentication. If successful, it needs to be confirmed, before usage of mfa

POST /v2/users/self/credentials/init-mfa/

API version

v2

Request method

POST

Operation ID

user-init-mfa

---

Request

Responses

Format

application/json

Beschreibung

The process of activating Multi Factor Authentication is initialized.

Schema-Dokumentation

• barcodestring

  required

  base64 encoded barcode content to scan from your mfa app. e.g. iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy.... You can display it with <img src="data:image/png;base64,iVBORw0KGgoAAAANSUh.." />

• urlstring

  required

  Same as barcode, but in URL form.

Beispiel

{
  "barcode": "string",
  "url": "otpauth://totp/mStudio:test@gmail.com?algorithm=SHA1&digits=6&issuer=mStudio&period=30&secret=HTXT7KJFVNAJUPYWQRWMNVQE5AF5YZI2"
}

JSON Schema

{
  "properties": {
    "barcode": {
      "description": "base64 encoded barcode content to scan from your mfa app. e.g. `iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy...`. You\ncan display it with `<img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUh..\" />`\n",
      "type": "string"
    },
    "url": {
      "description": "Same as barcode,  but in URL form.\n",
      "example": "otpauth://totp/mStudio:test@gmail.com?algorithm=SHA1&digits=6&issuer=mStudio&period=30&secret=HTXT7KJFVNAJUPYWQRWMNVQE5AF5YZI2",
      "type": "string"
    }
  },
  "required": [
    "barcode",
    "url"
  ],
  "type": "object"
}

Usage examples

cURL

$ curl \
    --fail \
    --location \
    -X POST \
    -d '{}' \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    -H 'Content-Type: application/json' \
    https://api.mittwald.de/v2/users/self/credentials/init-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.initMfa({
  "data": {}
});

assertStatus(response, 200);
  

PHP SDK

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

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

$request = (new InitMfaRequest(
  body: $body
));
$response = $client->user()->initMfa($request);

var_dump($response->getBody();