Update TOTP device name

Update the name of a TOTP device for a user.

PUT/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

existingDeviceNamestringrequired

Current name of the TOTP device

newDeviceNamestringrequired

New name for the TOTP device

Responses

200Indicates success with the status property

One of:

object

statusstatusOK

Allowed:OK

object

statusstring

Allowed:UNKNOWN_DEVICE_ERROR

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*existingDeviceNamestring*Current name of the TOTP devicenewDeviceNamestring*New name for the TOTP device

Request

curl -X PUT "/appid-{appId}/recipe/totp/device" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "existingDeviceName": "My Authy App",
  "newDeviceName": "A better name for my TOTP device"
}'

const response = await fetch("/appid-{appId}/recipe/totp/device", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "existingDeviceName": "My Authy App",
  "newDeviceName": "A better name for my TOTP device"
})
});

import requests

response = requests.put(
    "/appid-{appId}/recipe/totp/device",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "existingDeviceName": "My Authy App",
  "newDeviceName": "A better name for my TOTP device"
},
)

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"