Remove user ID mapping

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

POST/appid-{appId}/recipe/userid/map/remove

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

userIdTypestring

Type of user ID to remove mapping for

Allowed:SUPERTOKENSEXTERNALANY

forceboolean

Whether to force remove the mapping

Responses

200Indicates success with the status property

statusstatusOK

Allowed:OK

didMappingExistboolean

Indicates if the mapping existed before removal

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*userIdTypestringType of user ID to remove mapping forforcebooleanWhether to force remove the mapping

Request

curl -X POST "/appid-{appId}/recipe/userid/map/remove" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "userIdType": "SUPERTOKENS",
  "force": true
}'

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

import requests

response = requests.post(
    "/appid-{appId}/recipe/userid/map/remove",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "userIdType": "SUPERTOKENS",
  "force": True
},
)

Response

{
  "status": "OK",
  "didMappingExist": true
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"