Authorizations API Key WebAuthn (Passkey) Cryptographically signed (stamped) request to be passed in as a header. For more info, see
here .
Body
Enum options: ACTIVITY_TYPE_CREATE_READ_ONLY_SESSION
Timestamp (in milliseconds) of the request, used to verify liveness of user requests.
Unique identifier for a given Organization.
The parameters object containing the specific intent data for this activity.
Response
A successful response returns the following fields:
The activity object containing type, intent, and result Unique identifier for a given Activity object.
Unique identifier for a given Organization.
The intent of the activity activity.intent. createReadOnlySessionIntent
The createReadOnlySessionIntent object
The result of the activity activity.result. createReadOnlySessionResult
The createReadOnlySessionResult object Show createReadOnlySessionResult details
activity.result.createReadOnlySessionResult. organizationId
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
Human-readable name for an Organization.
activity.result.createReadOnlySessionResult. userId
Unique identifier for a given User.
activity.result.createReadOnlySessionResult. username
Human-readable name for a User.
activity.result.createReadOnlySessionResult. session
String representing a read only session
activity.result.createReadOnlySessionResult. sessionExpiry
UTC timestamp in seconds representing the expiry time for the read only session.
A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.
An artifact verifying a User’s action.
Whether the activity can be approved.
Whether the activity can be rejected.
The last update timestamp.
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>"
}
}
}
}