Regenerate session

Regenerate a session

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

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

userDataInJWTuserDataInJWT

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

Responses

200Regenerate user 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

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

Request body

Request

curl -X POST "/appid-{appId}/recipe/session/regenerate" \
  -H "api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "userDataInJWT": {
    "test": 123
  }
}'

const response = await fetch("/appid-{appId}/recipe/session/regenerate", {
  method: "POST",
  headers: {
    "api-key": "YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "userDataInJWT": {
    "test": 123
  }
})
});

import requests

response = requests.post(
    "/appid-{appId}/recipe/session/regenerate",
    headers={
        "api-key": "YOUR_API_KEY",
        "Content-Type": "application/json"
    },
    json={
  "accessToken": "ZTRiOTBjNz...jI5MTZlODkxw",
  "userDataInJWT": {
    "test": 123
  }
},
)

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"