Get user ID mapping

Retrieve a UserIdMapping

GET/appid-{appId}/recipe/userid/map

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

userIdTypestring

Allowed:SUPERTOKENSEXTERNALANY

Header parameters

ridstring

cdi-versionstring

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

Responses

200Retrives a userId mapping

One of:

object

statusstatusOKrequired

Allowed:OK

superTokensUserIduserIdrequired

externalUserIdstringrequired

The external user ID

externalUserIdInfostring

Additional information about the external user ID

object

statusstring

Allowed:UNKNOWN_MAPPING_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.userIdquery*userIdTypequery

Request

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

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

import requests

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

Response

{
  "status": "OK",
  "superTokensUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "externalUserId": "externalId",
  "externalUserIdInfo": "Info about external userId"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"