Delete session

Delete a sesion

If revoking session by userId, the sessions are cleared across all tenants by default.

Note: If revokeAcrossAllTenants is set to true, this API can only be called from public tenant.

POST/appid-{appId}/{tenantId}/recipe/session/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.

Path parameters

tenantIdstring

The tenant against which the request is made. If left empty, the default tenant will be used.

Header parameters

ridstring

cdi-versionstring

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

Request body

application/json

One of:

object

sessionHandlessessionHandles

object

userIduserIdrequired

revokeAcrossAllTenantsboolean

Responses

200Delete a session

statusstatusOK

Allowed:OK

sessionHandlesRevokedsessionHandles

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

tenantIdpath*The tenant against which the request is made. If left empty, the default tenant will be used.ridheadercdi-versionheaderX.Y of the X.Y.Z CDI version.

Bodyapplication/json

Request body

Request

curl -X POST "/appid-{appId}/public/recipe/session/remove" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionHandles": [
    "68en6gd6-865b-4af6-ba00-96e5c153257d"
  ]
}'

const response = await fetch("/appid-{appId}/public/recipe/session/remove", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "sessionHandles": [
    "68en6gd6-865b-4af6-ba00-96e5c153257d"
  ]
})
});

import requests

response = requests.post(
    "/appid-{appId}/public/recipe/session/remove",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "sessionHandles": [
    "68en6gd6-865b-4af6-ba00-96e5c153257d"
  ]
},
)

Response

{
  "status": "OK",
  "sessionHandlesRevoked": [
    "68en6gd6-865b-4af6-ba00-96e5c153257d"
  ]
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"