Set Session

Update an existing session with new information like additional checks or metadata or request additional challenges. A new session token will be returned. Note that the previous token will be invalidated.

Required permissions:

session.write

Path Parameters

session_id*string

The unique identifier of the session to be updated.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

sessionToken?stringDeprecated

Deprecated: the session token is no longer required when updating a session and will be ignored when provided.

checks?

metadata?

Additional custom key value pairs to be stored on the session. Existing keys will be overwritten. To delete a key, set its value to an empty byte array. Note that metadata keys cannot be changed once the session has been created. You need to create a new entry and delete the old one instead.

challenges?

lifetime?|

Update the duration after which the session will be automatically invalidated. If not set, the lifetime will not be changed. Note that an expired session cannot be used for authentication anymore, but will still be listed until it is deleted.

Response Body

`application/json`

curl -X PATCH "https://loading/v2/sessions/string" \  -H "Content-Type: application/json" \  -d '{}'

{
  "details": {
    "sequence": 0,
    "changeDate": "2023-01-15T01:30:15.01Z",
    "resourceOwner": "string",
    "creationDate": "2023-01-15T01:30:15.01Z"
  },
  "sessionToken": "string",
  "challenges": {
    "webAuthN": {
      "publicKeyCredentialRequestOptions": {
        "property1": {},
        "property2": {}
      }
    },
    "otpSms": "string",
    "otpEmail": "string"
  }
}

Path Parameters

Request Body

Response Body

200application/json

`application/json`