List user TOTP devices

Retrieve a list of TOTP devices for a user.

GET/appid-{appId}/recipe/totp/device/list

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.

Query parameters

userIdstringrequired

Header parameters

ridstring

cdi-versionstring

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

Responses

200Retrives all TOTP devices

One of:

object

statusstatusOKrequired

Allowed:OK

devicesobject[]

List of TOTP devices

Show properties

Array of object

namestring

Name of the TOTP device

periodnumber

Time period in seconds for TOTP code generation

skewnumber

Time skew in seconds for TOTP validation

verifiedboolean

Whether the device has been verified

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.userIdquery*

Request

curl -X GET "/appid-{appId}/recipe/totp/device/list?userId=string" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/recipe/totp/device/list?userId=string", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/recipe/totp/device/list?userId=string",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "devices": [
    {
      "name": "string",
      "period": 0,
      "skew": 0,
      "verified": true
    }
  ]
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"