Remove TOTP device

Remove a TOTP device for a user. If all devices are removed, TOTP is disabled for the user.

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

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

deviceNamestringrequired

Name of the TOTP device to remove

Responses

200Indicates success with the status property

One of:

object

statusstatusOK

Allowed:OK

didDeviceExistboolean

Indicates if the device existed before removal

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*deviceNamestring*Name of the TOTP device to remove

Request

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

const response = await fetch("/appid-{appId}/recipe/totp/device/remove", {
  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"
})
});

import requests

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

Response

{
  "status": "OK",
  "didDeviceExist": true
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"