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: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {}
}'
{
"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": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"createReadOnlySessionIntent": {}
},
"result": {
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
Create a read only session for a user (valid for 1 hour)
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: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {}
}'
{
"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": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"createReadOnlySessionIntent": {}
},
"result": {
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION
Show activity details
Show result details
Show createReadOnlySessionResult details
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: <string> (see Authorizations)" \
--data '{
"type": "ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION",
"timestampMs": "<string> (e.g. 1746736509954)",
"organizationId": "<string> (Your Organization ID)",
"parameters": {}
}'
{
"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": {
"id": "<string>",
"organizationId": "<string>",
"status": "<string>",
"type": "<string>",
"intent": {
"createReadOnlySessionIntent": {}
},
"result": {
"createReadOnlySessionResult": {
"organizationId": "<string>",
"organizationName": "<string>",
"userId": "<string>",
"username": "<string>",
"session": "<string>",
"sessionExpiry": "<string>"
}
},
"votes": "<array>",
"fingerprint": "<string>",
"canApprove": "<boolean>",
"canReject": "<boolean>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
}
}
}
Was this page helpful?