{
"client_session": {
"client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connect_webview_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"connected_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"device_count": 123,
"expires_at": "2023-11-07T05:31:56Z",
"token": "<string>",
"user_identifier_key": "<string>",
"user_identity_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_key": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Get or Create a Client Session
Returns a client session with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
{
"client_session": {
"client_session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"connect_webview_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"connected_account_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"created_at": "2023-11-07T05:31:56Z",
"device_count": 123,
"expires_at": "2023-11-07T05:31:56Z",
"token": "<string>",
"user_identifier_key": "<string>",
"user_identity_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"customer_key": "<string>",
"user_identity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Body
IDs of the Connect Webviews that you want to associate with the client session (or that are already associated with the existing client session).
IDs of the connected accounts that you want to associate with the client session (or that are already associated with the existing client session).
Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). When you authenticate with a publishable key, the user_identifier_key must be a high-entropy secret that only the user knows, such as a UUIDv4 or a salted hash. Do not use an email address, name, phone number, or other guessable value, because anyone who knows the user_identifier_key can retrieve the client session.
1ID of the user identity that you want to associate with the client session (or that are already associated with the existing client session).
Deprecated. Use user_identity_id.
IDs of the user identities that you want to associate with the client session.
1 elementResponse
OK
Represents a client session. If you want to restrict your users' access to their own devices, use client sessions. See the client_session object.
Show child attributes
Show child attributes
Was this page helpful?