Request information to setup TOTP as second authentication factor

v1.0.0

🚀 Since v4.37.0

Description:

Get setup information for multi-factor authentication (TOTP).

Precondition:

Authenticated user.

Postcondition:

None.

Further Information:

None.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Contains QR code URL and OTP URI for TOTP setup",
  "required": [
    "id",
    "otpUri",
    "qrCode",
    "secret"
  ],
  "properties": {
    "id": {
      "type": "integer",
      "format": "int64",
      "description": "ID"
    },
    "otpUri": {
      "type": "string",
      "description": "URI containing secret key, issuer and account information"
    },
    "qrCode": {
      "type": "string",
      "description": "TOTP data URL (QR Code)"
    },
    "secret": {
      "type": "string",
      "description": "Secret key used for setup of TOTP authentication"
    }
  }
}