"listSessions"
listSessions returns a list of active sessions that the logged-in account is authorized to see.
The "listSessions"
action returns a list of active sessions that the logged-in account is authorized to see. The list can be filtered to include sessions from specific usernames.
Request examples
Minimal request example
{ "api": "admin", "authToken": "anAuthorizationTokenFromTheServer", "action": "listSessions" }
{ "requestId": "2", "authToken": "anAuthorizationTokenFromTheServer", "api": "admin", "action": "listSessions", "params": { "usernameFilter": [ "jim" ] }, "responseOptions": { "binaryFormat": "hex", "dataFormat": "objects", "numberFormat": "string" }, "apiVersion": "1.0", "debug": "max" }
Response examples
{ "result": { "sessions": [ { "authToken": "anAuthorizationTokenFromTheServer", "username": "ADMIN", "description": "optional user description of session for troubleshooting" } ] }, "requestId": "00000045", "errorCode": 0, "errorMessage": "" }
{ "authToken": "invalidAuthtoken", "requestId": "2", "debugInfo": { "request": { "authToken": "invalidAuthtoken", "api": "admin", "action": "listSessions", "requestId": "2" } }, "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 strings of usernames of accounts in order to filter a list of sessions |
| array |
|
"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 |
|