Ask or search…
K
Links

Client Sessions and Client Session Tokens

Use a client session token to restrict access to the devices that a specific user owns.
A client session enables a client, such as a web browser or mobile phone, to access the Seam API directly. You can use client sessions to simplify your architecture. That is, when you use client sessions and client session tokens with the Seam JavaScript SDK, you can authenticate and authorize users of your web application directly with Seam.
Once you create a client session on the backend, you can pass the resulting generated client session token from the backend to the frontend (that is, to the client). Using client session tokens on the frontend eliminates the need for your user's browser to communicate with your backend server. Instead, the client makes requests directly to the Seam API.
Client sessions make it easy to control your users' access to devices. When you create a client session, you can specify your own internal user ID for a desired user, along with the connected accounts associated with this user. Then, you can use client sessions on the backend to limit your users to only the devices that they own.
If you are just getting started with Seam, see Seam Components. In only a few minutes and with just a few lines of code, you can start controlling devices from your web application without interacting with the backend.
Client sessions and client session tokens increase efficiency by enabling your user's browser to communicate directly with the Seam backend server.
You can only use a client session token in a browser context through the Seam JavaScript SDK. Do not use a client session token to make requests from the backend. Instead, use an API key. An API key has unlimited permission to manage all devices and other Seam API resources within a workspace. Never use an API key in the browser or expose it to your users.
You can use client sessions in the following two ways:
  • Create a client session on the backend and pass the resulting generated client session token to your frontend. You use this client session token in the frontend with the Seam JavaScript SDK or Seam Components.
  • Manage client sessions entirely on the frontend by using a publishable key with the JavaScript SDK or Seam Components.

Create a Client Session for an Existing User and Retrieve the Session Token

To create a client session for an existing user with connected accounts in your workspace, include the IDs of the user's connected accounts (connected_account_ids) and provide your own unique internal user ID (user_identifier_key). Then, use the generated client session token to retrieve and manage the resources authorized through the connected accounts associated with this client session.
JavaScript
Request:
const client_session = await seam.clientSessions.create({
user_identifier_key: "internal-user-id-1",
connected_account_ids: [
"3ea0b67f-649f-4131-bfe3-f2035e77a3f9",
"6e1cad57-b244-40ca-b4f3-30a46c8000d4",
]
})
console.log(`Client session token: ${client_session.token}`)
Response:
Client session token: seam_cst1891oqCmE_6dBwV8PJ2Ffoe9dWYVyMfVHq

List Client Sessions

You can list all client sessions within your workspace.
JavaScript
Request:
await seam.clientSessions.list()
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',
user_identity_ids: [],
third_party_account_ids: [
'3ea0b67f-649f-4131-bfe3-f2035e77a3f9',
'6e1cad57-b244-40ca-b4f3-30a46c8000d4'
],
connect_webview_ids: [],
device_count: 4,
connected_account_ids: [
'3ea0b67f-649f-4131-bfe3-f2035e77a3f9',
'6e1cad57-b244-40ca-b4f3-30a46c8000d4'
]
},
{
workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
token: 'seam_cst1891oqCmE_6dBwV8PJ2Ffoe9dWYVyMfVHq',
user_identifier_key: 'internal user ID 2',
created_at: '2023-12-26T04:25:50.041Z',
client_session_id: 'e1006128-19a8-4e4d-9a91-536d80cf9c21',
user_identity_ids: [],
third_party_account_ids: [
'2e884e71-b2c1-41a0-bb2c-ec94a7b4c6a4',
'b0ccf472-cb63-400c-bf21-5b809f5e1afd'
],
connect_webview_ids: [],
device_count: 4,
connected_account_ids: [
'2e884e71-b2c1-41a0-bb2c-ec94a7b4c6a4',
'b0ccf472-cb63-400c-bf21-5b809f5e1afd'
]
},
...
]

Get a Client Session

To get a specific client session, provide the client session ID (client_session_id).
JavaScript
Request:
const clientSession = await seam.clientSessions.get({
client_session_id: "c75d4330-ae01-4dfd-b6c5-f3e94e0d8168",
}))
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: []
}

Delete a Client Session

To delete a client session, provide the client session ID (client_session_id).
JavaScript
Request:
await seam.clientSessions.delete({
client_session_id: "639eb8af-19a9-4ae5-817c-6ad08fd078e7",
})

Next Steps