Get session info

Get user and session information for a given session handle

GET/appid-{appId}/recipe/session

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.

Query parameters

sessionHandlehandle

Header parameters

ridstring

cdi-versionstring

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

Responses

200Get user and session information for a given session handle

One of:

object

statusstatusOK

Allowed:OK

userDataInDatabaseuserDataInDatabase

should be a JSON object (not a JSON literal nor an array)

userDataInJWTuserDataInJWT

should be a JSON object (not a JSON literal nor an array)

userIduserId

expiryexpiry

timeCreatedtimeCreated

sessionHandlehandle

tenantIdtenantId

unauthorisedMessageResponse

statusunauthorisedResponse

Allowed:UNAUTHORISED

messagemessage

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

Request

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

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

import requests

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

Response

{
  "status": "OK",
  "userDataInDatabase": {
    "test": 123
  },
  "userDataInJWT": {
    "test": 123
  },
  "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
  "expiry": 1637262633029,
  "timeCreated": 1637262633029,
  "sessionHandle": "68en6gd6-865b-4af6-ba00-96e5c153257d",
  "tenantId": "customer1"
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"