Authorize New 2FA Method

Initiates authorization to add a new 2FA method by verifying identity with an existing method or backup code, returning a value used in the verification step.

POST /api/v0/tfa/authorize-new-method/

Authorize New 2FA Method

cURL

curl --request POST \
  --url https://console.vast.ai/api/v0/tfa/authorize-new-method/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tfa_method": "email",
  "tfa_method_id": 3,
  "backup_code": "ABCD-EFGH-1234"
}
'

import requests

url = "https://console.vast.ai/api/v0/tfa/authorize-new-method/"

payload = {
    "tfa_method": "email",
    "tfa_method_id": 3,
    "backup_code": "ABCD-EFGH-1234"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({tfa_method: 'email', tfa_method_id: 3, backup_code: 'ABCD-EFGH-1234'})
};

fetch('https://console.vast.ai/api/v0/tfa/authorize-new-method/', 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://console.vast.ai/api/v0/tfa/authorize-new-method/",
  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([
    'tfa_method' => 'email',
    'tfa_method_id' => 3,
    'backup_code' => 'ABCD-EFGH-1234'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://console.vast.ai/api/v0/tfa/authorize-new-method/"

	payload := strings.NewReader("{\n  \"tfa_method\": \"email\",\n  \"tfa_method_id\": 3,\n  \"backup_code\": \"ABCD-EFGH-1234\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://console.vast.ai/api/v0/tfa/authorize-new-method/")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tfa_method\": \"email\",\n  \"tfa_method_id\": 3,\n  \"backup_code\": \"ABCD-EFGH-1234\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://console.vast.ai/api/v0/tfa/authorize-new-method/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tfa_method\": \"email\",\n  \"tfa_method_id\": 3,\n  \"backup_code\": \"ABCD-EFGH-1234\"\n}"

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

200

{
  "success": true,
  "secret": "abc123randomtoken"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

{
  "error": "<string>",
  "msg": "<string>"
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

tfa_method · enum<string>

Existing method type to use for authorization; automatically 'email' when the account has no active methods

Available options: sms, totp, email

Example:

"email"

tfa_method_id · integer

ID of an existing method to verify with; required for sms/totp when the user has multiple methods of the same type

Example:

3

backup_code · string

Backup code that skips the send/verify round-trip and grants authorization directly

Example:

"ABCD-EFGH-1234"

Response

200

application/json

Returns {success: true, secret} (secret needed for PUT verify step), or {success: true, msg: "Authorization successful."} when a backup code is used.

success · boolean

Always true

secret · string

TFA secret required for the PUT verification step (present when using a send/verify flow)

msg · string

"Authorization successful." (present when backup_code is used and authorization is granted immediately)