Create user ID mapping

Create a mapping between a SuperTokens userId and an external userId.

POST/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.

Header parameters

ridstring

cdi-versionstring

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

Request body

application/json

superTokensUserIduserIdrequired

externalUserIdstringrequired

The external user ID to map to

externalUserIdInfostring

Additional information about the external user ID

forceboolean

Whether to force create the mapping even if it exists

Responses

200Indicates success with the status property

One of:

object

statusstatusOK

Allowed:OK

object

statusstring

Allowed:UNKNOWN_SUPERTOKENS_USER_ID_ERROR

object

statusstring

Allowed:USER_ID_MAPPING_ALREADY_EXISTS_ERROR

doesSuperTokensUserIdExistboolean

doesExternalUserIdExistboolean

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

superTokensUserIdstring*externalUserIdstring*The external user ID to map toexternalUserIdInfostringAdditional information about the external user IDforcebooleanWhether to force create the mapping even if it exists

Request

curl -X POST "/appid-{appId}/recipe/userid/map" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "superTokensUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "externalUserId": "externalId",
  "externalUserIdInfo": "Info about external userId",
  "force": true
}'

const response = await fetch("/appid-{appId}/recipe/userid/map", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "superTokensUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "externalUserId": "externalId",
  "externalUserIdInfo": "Info about external userId",
  "force": true
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/userid/map",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "superTokensUserId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "externalUserId": "externalId",
  "externalUserIdInfo": "Info about external userId",
  "force": True
},
)

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"