Delete user

POST/appid-{appId}/user/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

cdi-versionstring

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

Request body

application/json

userIduserIdrequired

removeAllLinkedAccountsboolean

Responses

200Returns OK if the operation succeeded (even if the user didn't exist before the call)

statusstatusOK

Allowed:OK

400error code 400

string

401error code 401

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

cdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

userIdstring*removeAllLinkedAccountsboolean

Request

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

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

import requests

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

Response

{
  "status": "OK"
}

"string"

"Invalid API key"

"Internal Error"