Authentication
Start TOTP enrollment
Starts TOTP enrollment and returns QR code and secret for authenticator app
POST
/
v1
/
auth
/
mfa
/
totp
/
enroll
Start TOTP enrollment
curl --request POST \
--url https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll \
--header 'Content-Type: application/json' \
--data '
{
"friendlyName": "My Authenticator"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll"
payload = { "friendlyName": "My Authenticator" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({friendlyName: 'My Authenticator'})
};
fetch('https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll', 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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll",
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([
'friendlyName' => 'My Authenticator'
]),
CURLOPT_HTTPHEADER => [
"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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll"
payload := strings.NewReader("{\n \"friendlyName\": \"My Authenticator\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll")
.header("Content-Type", "application/json")
.body("{\n \"friendlyName\": \"My Authenticator\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"friendlyName\": \"My Authenticator\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "TOTP enrollment started. Scan the QR code with your authenticator app.",
"data": {
"factorId": "factor-550e8400-e29b-41d4-a716-446655440000",
"qrCode": "data:image/svg+xml;base64,...",
"secret": "JBSWY3DPEHPK3PXP",
"totpUri": "otpauth://totp/Hyperprop:user@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Hyperprop"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "TOTP is already enabled",
"code": "TOTP_ALREADY_ENABLED"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}Related topics
Verify TOTP enrollmentDisable TOTPVerify TOTP challengeCreate TOTP challengeGet MFA factors⌘I
Start TOTP enrollment
curl --request POST \
--url https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll \
--header 'Content-Type: application/json' \
--data '
{
"friendlyName": "My Authenticator"
}
'import requests
url = "https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll"
payload = { "friendlyName": "My Authenticator" }
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({friendlyName: 'My Authenticator'})
};
fetch('https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll', 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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll",
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([
'friendlyName' => 'My Authenticator'
]),
CURLOPT_HTTPHEADER => [
"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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll"
payload := strings.NewReader("{\n \"friendlyName\": \"My Authenticator\"\n}")
req, _ := http.NewRequest("POST", url, payload)
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://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll")
.header("Content-Type", "application/json")
.body("{\n \"friendlyName\": \"My Authenticator\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/auth/mfa/totp/enroll")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"friendlyName\": \"My Authenticator\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "TOTP enrollment started. Scan the QR code with your authenticator app.",
"data": {
"factorId": "factor-550e8400-e29b-41d4-a716-446655440000",
"qrCode": "data:image/svg+xml;base64,...",
"secret": "JBSWY3DPEHPK3PXP",
"totpUri": "otpauth://totp/Hyperprop:user@example.com?secret=JBSWY3DPEHPK3PXP&issuer=Hyperprop"
}
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "TOTP is already enabled",
"code": "TOTP_ALREADY_ENABLED"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}