"describeSessions"
describeSessions returns one or more session objects that the logged-in account is authorized to view.
The "describeSessions"
describes one or more sessions.
If the
"authTokens"
property is omitted,"describeSessions"
describes all active sessions created by the account.If the
"authTokens"
property is included,"describeSessions"
describes only the sessions listed in the"authTokens"
property and only those sessions that the account is authorized to view.
Request examples
Minimal request example
{ "api": "admin", "authToken": "anAuthorizationTokenFromTheServer", "action": "describeSessions" }
{ "api": "admin", "requestId": "2", "authToken": "replaceWithValidAuthtoken", "action": "describeSessions", "params": { "authTokens": [ "replaceWithValidAuthtoken", "replaceWithAnotherValidAuthtoken" ] } }
{ "requestId": "3", "authToken": "replaceWithValidAuthtoken", "api": "admin", "action": "describeSessions", "params": { "authTokens": [ "replaceWithValidAuthtoken", "replaceWithAnotherValidAuthtoken" ] }, "responseOptions": { "binaryFormat": "hex", "dataFormat": "objects", "numberFormat": "string" }, "apiVersion": "1.0", "debug": "max" }
Response examples
{ "authToken": "replaceWithValidAuthtoken", "result": { "sessions": [ { "authToken": "replaceWithValidAuthtoken", "username": "ADMIN", "description": "", "defaultDatabaseName": "ctreeSQL", "defaultOwnerName": "admin", "defaultBinaryFormat": "base64", "defaultResponseOptions": { "binaryFormat": "hex", "dataFormat": "objects", "numberFormat": "number" }, "idleConnectionTimeoutSeconds": 3600, "idleCursorTimeoutSeconds": 600, "defaultApi": "db", "defaultDebug": "none", "sessionStartTimestamp": "2023-03-31T15:15:51", "sessionLastAccessedTimestamp": "2023-03-31T15:38:11", "hostname": "zeus2", "hostUuid": "204f0f2f-dfba-4765-9352-504b46980ce9", "hostIpAddresses": ["10.243.251.132"], "hostServerNamePort": "5597", "hostSQLPort": "6597" } ] }, "requestId": "00000008", "errorCode": 0, "errorMessage": "" }
{ "authToken": "invalidAuthtoken", "debugInfo": { "request": { "authToken": "invalidAuthtoken", "api": "admin", "action": "describeSessions" } }, "errorCode": 12031, "errorMessage": "'authToken' does not match any existing session. Use a valid 'authToken' or use 'createSession' to create a valid 'authToken'." }
"params"
The "params"
property is an object that contains an action's parameters. Each action defines its own required and optional properties.
Property summary
"params"
property summariesProperty | Description | Default | Type | Limits (inclusive) |
---|---|---|---|---|
| contains one or more authorization token strings |
| array | At least one |
"result"
The "result"
property is a required object set by the server that contains the result of an action.
It is a required part of the jsonAction specification standard.
Its properties vary with each action.
Property summary
"result"
property summariesProperty | Description | Type | Limits (inclusive) |
---|---|---|---|
contains session objects where each session minimally describes a session | array of objects |
The "sessions"
property is an array of session objects where each session object minimally describes a session.
"sessions"
property summariesProperty | Description | Type | Limits (inclusive) | |||
---|---|---|---|---|---|---|
| signifies that the client is authenticated and authorized signifies that the client is authenticated and authorized | string |
| |||
| defines the default value for the | string |
| |||
| defines the default value of the | string |
| |||
| defines a default value for | object | One of the following:
| |||
| specifies the initial value of the | string |
| |||
| allows the client to describe an object for later identification | string |
| |||
| contains the name of the host device | string | ||||
| contains the universal identifier of the server instance | string | ||||
| contains the IP addresses of the host | array of strings | ||||
| contains the server’s ISAM port or server name | string | ||||
| contains the server’s SQL port | string | ||||
| contains the number of seconds that a session with no activity will stay open | integer |
| |||
| contains the number of seconds to keep a cursor open | integer |
| |||
| contains the UTC date and time in ISO 8601 format of when the session was created | string | ||||
| contains the UTC date and time in ISO 8601 format of when the session last received a JSON Action message including the last time the session was pinged | string | ||||
| contains the account name of a user or application | string |
|