Get user session handles

Get session handles for a user

By default, the session handles are fetched across all tenants. Set fetchAcrossAllTenants to false to get sessionHandles for the user for a particular tenant.

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

GET/appid-{appId}/{tenantId}/recipe/session/user

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.

Query parameters

userIdstring

fetchAcrossAllTenantsstring

Allowed:truefalse

Header parameters

ridstring

cdi-versionstring

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

Responses

200Get user Session Handles

statusstatusOK

Allowed:OK

sessionHandlessessionHandles

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.userIdqueryfetchAcrossAllTenantsquery

Request

curl -X GET "/appid-{appId}/public/recipe/session/user" \
  -H "api-key: YOUR_API_KEY"

const response = await fetch("/appid-{appId}/public/recipe/session/user", {
  method: "GET",
  headers: {
    "api-key": "YOUR_API_KEY"
  }
});

import requests

response = requests.get(
    "/appid-{appId}/public/recipe/session/user",
    headers={
        "api-key": "YOUR_API_KEY"
    },
)

Response

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

"string"

"Invalid API key"

"Not Found"

"Internal Error"