Confirm your new multi factor

POST/v1/mfa/actions/confirm/

API version

v1

Request method

POST

Operation ID

confirmMfa

---

This action returns recovery codes you can use to authenticate once.\nKeep track of them carefully. Don not lose them.\n

Request

Responses

Format

application/json

Beschreibung

Mfa is now activated. You can not login without your mfa again.\n

Schema-Dokumentation

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

  required

  A recovery code may only be used once. They can be used if you lose access to your mfa device.\n

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

Beispiel

Content-Type: application/json

{
  "recoveryCodesList": [
    1234123412341234
  ]
}

JSON Schema

{
  "type": "object",
  "required": [
    "recoveryCodesList"
  ],
  "properties": {
    "recoveryCodesList": {
      "type": "array",
      "maxItems": 20,
      "minItems": 20,
      "description": "A recovery code may only be used once. They can be used if\nyou lose access to your mfa device.\\n\n",
      "items": {
        "type": "string",
        "minLength": 16,
        "maxLength": 16,
        "example": 1234123412341234
      }
    }
  }
}

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/v1/mfa/actions/confirm