Set TOTP MFA key

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

POST /api/user/mfa/totp/set-key

Set TOTP MFA key

cURL

curl --request POST \
  --url https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "key": "<string>",
  "totpToken": "<string>"
}
'

import requests

url = "https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key"

payload = {
    "key": "<string>",
    "totpToken": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({key: '<string>', totpToken: '<string>'})
};

fetch('https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'totpToken' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"totpToken\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"totpToken\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://studio.edgeimpulse.com/v1/api/user/mfa/totp/set-key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"totpToken\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "success": true,
  "recoveryCodes": [
    "<string>"
  ],
  "error": "<string>"
}

Authorizations

ApiKeyAuthenticationJWTAuthenticationJWTHttpHeaderAuthenticationOAuth2

x-api-key · string · header · required

Body

application/json

key · string · required

Secret key obtained through userGenerateNewMfaKey.

totpToken · string · required

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

Response

200 - application/json

OK

success · boolean · required

Whether the operation succeeded

recoveryCodes · string[] · required

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.

error · string

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