Get a Client Session

Get a specified client session

Returns a specified client session.

Request

Specify the desired client session by including the corresponding client_session_id in the request body.

Sample Request

const clientSession = await seam.clientSessions.get({
  client_session_id: "c75d4330-ae01-4dfd-b6c5-f3e94e0d8168",
})

Request Body Parameters

ParameterTypeDescription

client_session_id

String Required

ID of the desired client session

Response

Returns a client_session containing the following properties:

PropertyDescription

workspace_id

ID of the workspace that contains the client session

token

Client session token associated with the client session

user_identifier_key

Your own internal user ID for the user

created_at

Date and time at which the client session was created

client_session_id

ID of the client session

device_count

Number of devices to which the client session grants access

connected_account_ids

Array of connected account IDs associated with this client session

connect_webview_ids

Array of Connect Webview IDs associated with the client session

user_identity_ids

Array of user identity IDs on behalf of which which the client session may act

This response also includes a Boolean ok status indicator.

Sample Response

{
  workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
  token: 'seam_cst1271Q3JUh_A3ECdSrrqgYp98SmB9qY2NGp',
  user_identifier_key: 'internal user ID 1',
  created_at: '2023-12-26T04:23:46.829Z',
  client_session_id: 'c75d4330-ae01-4dfd-b6c5-f3e94e0d8168',
  device_count: 4,
  connected_account_ids: [
    '3ea0b67f-649f-4131-bfe3-f2035e77a3f9',
    '6e1cad57-b244-40ca-b4f3-30a46c8000d4'
  ],
  connect_webview_ids: [],
  user_identity_ids: []
}

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.