Skip to main content
Version: API v1

Get your current multi factor auth secret

GET/v1/mfa/secret
API version
v1
Request method
GET
Operation ID
getMfaSecret

Request​

Responses​

Format
application/json
Description

Multi factor auth secret

  • barcodestringrequired

    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

  • urlstringrequired

    Same as barcode, but in URL form.\n

Content-Type: application/json

{
  "barcode": "string",
  "url": "otpauth://totp/mStudio:test@gmail.com?algorithm=SHA1&digits=6&issuer=mStudio&period=30&secret=HTXT7KJFVNAJUPYWQRWMNVQE5AF5YZI2"
}
{
  "type": "object",
  "required": [
    "barcode",
    "url"
  ],
  "properties": {
    "barcode": {
      "type": "string",
      "description": "base64 encoded barcode content to scan from your mfa app.\ne.g. `iVBORw0KGgoAAAANSUhEUgAAAMgAAADIEAAAAADYoy...`.\nYou\\ncan display it with `<img\nsrc=\\\"data:image/png;base64,iVBORw0KGgoAAAANSUh..\\\" />`\\n\n"
    },
    "url": {
      "type": "string",
      "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"
    }
  }
}

Usage examples​

$ curl \
    --fail \
    --location \
    -H "Authorization: Bearer $MITTWALD_API_TOKEN" \
    https://api.mittwald.de/v1/mfa/secret?multiFactorCode=string

On this page