List passwordless codes

Lists all active passwordless codes of the user

GET/appid-{appId}/{tenantId}/recipe/signinup/codes

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.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Query parameters

emailstring

Use this parameter to get information about all devices associated with an email (without the other query params)

phoneNumberphoneNumber

Use this parameter to get information about all devices associated with a phoneNumber (without the other query params)

deviceIddeviceId

Use this parameter to get information about a single device (without the other query params)

preAuthSessionIdpreAuthSessionId

Use this parameter to get information about a single device (without the other query params)

Header parameters

ridstring

cdi-versionstring

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

Responses

200List of all active passwordless codes of the user

statusstatusOK

Allowed:OK

devicesobject[]

Show properties

Array of object

preAuthSessionIdpreAuthSessionId

A random identifier that can be used to identify the login attempt/device.

failedCodeInputAttemptCountnumber

emailemail

phoneNumberphoneNumber

codesobject[]

Show properties

Array of object

codeIdcodeId

Uniquely identifies a code

timeCreatedtimeCreated

codeLifetimecodeLifetime

The maximum lifetime of the code in milliseconds

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

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.emailqueryUse this parameter to get information about all devices associated with an email (without the other query params)phoneNumberqueryUse this parameter to get information about all devices associated with a phoneNumber (without the other query params)deviceIdqueryUse this parameter to get information about a single device (without the other query params)preAuthSessionIdqueryUse this parameter to get information about a single device (without the other query params)

Request

curl -X GET "/appid-{appId}/public/recipe/signinup/codes" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/public/recipe/signinup/codes", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/public/recipe/signinup/codes",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

{
  "status": "OK",
  "devices": [
    {
      "preAuthSessionId": "kFmkPQEAJtACiT2w/K8fndEuNm+XozJXSZSlWEr+iGs=",
      "failedCodeInputAttemptCount": 2,
      "email": "[email protected]",
      "phoneNumber": "+14155552671",
      "codes": [
        {
          "codeId": "QZ0Mx9zG9cfqNXmPI0I/67r9bpKghUBDQZeMMbayi+I=",
          "timeCreated": 1637262633029,
          "codeLifetime": 900000
        }
      ]
    }
  ]
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"