Create Read Only Session

Create a read only session for a user (valid for 1 hour)

POST

/

public

/

v1

/

submit

/

create_read_only_session

Authorizations

API Key

X-Stamp

string

header

required

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

parameters field

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createReadOnlySessionIntent

object

required

The createReadOnlySessionIntent object

activity.result

object

required

The result of the activity

Show result details

activity.result.createReadOnlySessionResult

object

required

The createReadOnlySessionResult object

Show createReadOnlySessionResult details

activity.result.createReadOnlySessionResult.organizationId

string

required

Unique identifier for a given Organization. If the request is being made by a user and their Sub-Organization ID is unknown, this can be the Parent Organization ID. However, using the Sub-Organization ID is preferred due to performance reasons.

activity.result.createReadOnlySessionResult.organizationName

string

required

Human-readable name for an Organization.

activity.result.createReadOnlySessionResult.userId

string

required

Unique identifier for a given User.

activity.result.createReadOnlySessionResult.username

string

required

Human-readable name for a User.

activity.result.createReadOnlySessionResult.session

string

required

String representing a read only session

activity.result.createReadOnlySessionResult.sessionExpiry

string

required

UTC timestamp in seconds representing the expiry time for the read only session.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_read_only_session \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {}
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "type": "<string>",
        "intent": {
          "createReadOnlySessionIntent": {}
        },
        "result": {
          "createReadOnlySessionResult": {
            "organizationId": "<string>",
            "organizationName": "<string>",
            "userId": "<string>",
            "username": "<string>",
            "session": "<string>",
            "sessionExpiry": "<string>"
          }
        }
      }
    }
  }
}