Set TOTP MFA key

Set TOTP MFA key

Enable MFA on this account using an TOTP token. First create a new key via userGenerateNewTotpMfaKey.

POSThttps://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key

Body

application/json

key*string

Secret key obtained through userGenerateNewMfaKey.

totpToken*string

TOTP token that is valid for the key (to ensure the device is configured correctly)

Response

200

OK

Body

application/json

success*boolean

Whether the operation succeeded

errorstring

Optional error description (set if 'success' was false)

recoveryCodes*array of string

10 recovery codes, which can be used in case you've lost access to your MFA TOTP app. Recovery codes are single use. Once you've used a recovery code once, it can not be used again.

Request

JavaScriptCurlPython

const response = await fetch('https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "text",
      "totpToken": "text"
    }),
});
const data = await response.json();

Response

200

{
  "success": false,
  "error": "text",
  "recoveryCodes": [
    "text"
  ]
}