Update external user info

Update or delete externalUserIdInfo

PUT/appid-{appId}/recipe/userid/external-user-id-info

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 update info for

Allowed:SUPERTOKENSEXTERNALANY

externalUserIdInfostring | nullrequired

New external user ID information

Responses

200Indicates success with the status property

One of:

object

statusstatusOK

Allowed:OK

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.

Bodyapplication/json

userIdstring*userIdTypestringType of user ID to update info forexternalUserIdInfostring*New external user ID information

Request

curl -X PUT "/appid-{appId}/recipe/userid/external-user-id-info" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "userIdType": "SUPERTOKENS",
  "externalUserIdInfo": "new external userId info"
}'

const response = await fetch("/appid-{appId}/recipe/userid/external-user-id-info", {
  method: "PUT",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "userIdType": "SUPERTOKENS",
  "externalUserIdInfo": "new external userId info"
})
});

import requests

response = requests.put(
    "/appid-{appId}/recipe/userid/external-user-id-info",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "userIdType": "SUPERTOKENS",
  "externalUserIdInfo": "new external userId info"
},
)

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"