Delete a tenant

Delete a tenant.

Request must originate from public tenant.

POST/appid-{appId}/recipe/multitenancy/tenant/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

tenantIdtenantIdrequired

Responses

200Remove tenant result

statusstatusOKrequired

Allowed:OK

didExistbooleanrequired

400error code 400

string

401error code 401

string

402error code 402

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

tenantIdstring*

Request

curl -X POST "/appid-{appId}/recipe/multitenancy/tenant/remove" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "tenantId": "customer1"
}'

const response = await fetch("/appid-{appId}/recipe/multitenancy/tenant/remove", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "tenantId": "customer1"
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/multitenancy/tenant/remove",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "tenantId": "customer1"
},
)

Response

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

"string"

"Invalid API key"

"License Error"

"Not Found"

"Internal Error"