List Client Sessions
Get all client sessions
Returns a list of all client sessions.
/client_sessions/list
OK
Request
List all client sessions or filter the list of client sessions by including the corresponding filter parameters in the request body.
Request Body Parameters
Parameter | Type | Description |
---|---|---|
| String Optional | ID of the client session that you want to retrieve |
| String Optional | Your own internal user ID for the user by which to filter client sessions |
| String Optional | ID of the Connect Webview for which you want to retrieve client sessions |
| Boolean Optional | Indicates whether to retrieve only client sessions without associated user identifier keys |
Sample Request
Response
Returns a client_sessions
array, in which each returned client session (client_session
) contains the following properties:
Property | Description |
---|---|
| ID of the workspace that contains the client session |
| Client session token associated with the client session |
| Your own internal user ID for the user |
| Date and time at which the client session was created |
| ID of the client session |
| Array of user identity IDs on behalf of which which the client session may act |
| Array of Connect Webview IDs associated with the client session |
| Number of devices to which the client session grants access |
| Array of connected account IDs associated with this client session |
This response also includes a Boolean ok
status indicator.
Sample Response
Last updated