Add TOTP device for user

Add a TOTP device for a user and enable TOTP if not already enabled.

POST/appid-{appId}/recipe/totp/device

Authorization

api-keyAPI key · headerrequired

The core service API token. If you are using a self-hosted core service and you have not generated a token, you can omit the header.

Header parameters

ridstring

cdi-versionstring

X.Y of the X.Y.Z CDI version.

Request body

application/json

userIduserIdrequired

deviceNamestring

Name of the TOTP device

skewnumberrequired

Time skew in seconds for TOTP validation

periodnumberrequired

Time period in seconds for TOTP code generation

Responses

200Indicates success with the status and secret properties

One of:

object

statusstatusOK

Allowed:OK

secretstring

The TOTP secret key for the device

deviceNamestring

Name of the created TOTP device

object

statusstring

Allowed:DEVICE_ALREADY_EXISTS_ERROR

400error code 400

string

401error code 401

string

404error code 404

string

500error code 500

string

Try it

Server

Custom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

userIdstring*deviceNamestringName of the TOTP deviceskewnumber*Time skew in seconds for TOTP validationperiodnumber*Time period in seconds for TOTP code generation

Request

curl -X POST "/appid-{appId}/recipe/totp/device" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "deviceName": "My Authy App",
  "skew": 0,
  "period": 30
}'

const response = await fetch("/appid-{appId}/recipe/totp/device", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "deviceName": "My Authy App",
  "skew": 0,
  "period": 30
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/totp/device",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "deviceName": "My Authy App",
  "skew": 0,
  "period": 30
},
)

Response

{
  "status": "OK",
  "secret": "JBSWY3DPEHPK3PXP",
  "deviceName": "d1"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"