Activities
- Overview
- Create API Keys
- Create Authenticators
- Create Invitations
- Create Oauth Providers
- Create Policies
- Create Policy
- Create Private Key Tag
- Create Private Keys
- Create Read Only Session
- Create Read Write Session
- Create Sub-Organization
- Create User Tag
- Create Users
- Create Wallet
- Create Wallet Accounts
- Delete API Keys
- Delete Authenticators
- Delete Invitation
- Delete Oauth Providers
- Delete Policy
- Delete Private Key Tags
- Delete Private Keys
- Delete Sub Organization
- Delete User Tags
- Delete Users
- Delete Wallets
- Export Private Key
- Export Wallet
- Export Wallet Account
- Import Private Key
- Import Wallet
- Init Email Recovery
- Init Generic OTP
- Init Import Private Key
- Init Import Wallet
- Init OTP auth
- Login with a Stamp
- Login with Oauth
- Login with OTP
- Oauth
- OTP auth
- Perform Email Auth
- Recover a user
- Remove Organization Feature
- Set Organization Feature
- Sign Raw Payload
- Sign Raw Payloads
- Sign Transaction
- Update Policy
- Update Private Key Tag
- Update Root Quorum
- Update User
- Update User Tag
- Update Wallet
- Verify Generic OTP
Queries
- Overview
- Get Activity
- Get API key
- Get API keys
- Get Authenticator
- Get Authenticators
- Get Configs
- Get Oauth providers
- Get Policy
- Get Private Key
- Get Suborgs
- Get User
- Get Verified Suborgs
- Get Wallet
- Get Wallet Account
- List Activities
- List Policies
- List Private Key Tags
- List Private Keys
- List User Tags
- List Users
- List Wallets
- List Wallets Accounts
- Who am I?
Create Read Only Session
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: <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": {}
}'
{
"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>"
}
}
}
}
}
}
Authorizations
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.
parameters field
Response
A successful response returns the following fields:
The activity object containing type, intent, and result
Show activity details
Show activity details
The result of the activity
Show result details
Show result details
The createReadOnlySessionResult object
Show createReadOnlySessionResult details
Show createReadOnlySessionResult details
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.
Human-readable name for an Organization.
String representing a read only session
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": {}
}'
{
"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>"
}
}
}
}
}
}
Was this page helpful?
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": {}
}'
{
"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>"
}
}
}
}
}
}