Verify session

Verify a Session

POST/appid-{appId}/recipe/session/verify

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

accessTokentoken

enableAntiCsrfenableAntiCsrf

doAntiCsrfCheckboolean

checkDatabaseboolean

Decides if we always check if the session exists in the DB or just do token validation, defaults to false.

antiCsrfTokentoken

Responses

200Verify a session

One of:

object

statusstatusOK

Allowed:OK

sessionsession

Show properties

handlehandle

userIduserId

userDataInJWTuserDataInJWT

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

tenantIdtenantId

recipeUserIduserId

accessTokencookieInfo

Show properties

tokentoken

expiryexpiry

createdTimetimeCreated

unauthorisedMessageResponse

statusunauthorisedResponse

Allowed:UNAUTHORISED

messagemessage

object

statustryRefreshTokenResponse

Allowed:TRY_REFRESH_TOKEN

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.

Bodyapplication/json

accessTokenstringenableAntiCsrfbooleandoAntiCsrfCheckbooleancheckDatabasebooleanDecides if we always check if the session exists in the DB or just do token validation, defaults to false.antiCsrfTokenstring

Request

curl -X POST "/appid-{appId}/recipe/session/verify" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "enableAntiCsrf": false,
  "doAntiCsrfCheck": false,
  "checkDatabase": false,
  "antiCsrfToken": "ZTRiOTBjNz...jI5MTZlODkxw"
}'

const response = await fetch("/appid-{appId}/recipe/session/verify", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "enableAntiCsrf": false,
  "doAntiCsrfCheck": false,
  "checkDatabase": false,
  "antiCsrfToken": "ZTRiOTBjNz...jI5MTZlODkxw"
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/session/verify",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "enableAntiCsrf": False,
  "doAntiCsrfCheck": False,
  "checkDatabase": False,
  "antiCsrfToken": "ZTRiOTBjNz...jI5MTZlODkxw"
},
)

Response

{
  "status": "OK",
  "session": {
    "handle": "68en6gd6-865b-4af6-ba00-96e5c153257d",
    "userId": "fa7a0841-b533-4478-95533-0fde890c3483",
    "userDataInJWT": {
      "test": 123
    },
    "tenantId": "customer1",
    "recipeUserId": "fa7a0841-b533-4478-95533-0fde890c3483"
  },
  "accessToken": {
    "token": "ZTRiOTBjNz...jI5MTZlODkxw",
    "expiry": 1637262633029,
    "createdTime": 1637262633029
  }
}

"string"

"Invalid API key"

"Not Found"

"Internal Error"