Grant Access to a Client Session

Grants a client session access to one or more resources, such as Connect Webviews, user identities, and so on.

POST /client_sessions/grant_access

JavaScript

Seam SDK

await seam.clientSessions.grantAccess({
  client_session_id: "3ada79d3-2848-4320-b2ef-a82e1e6dafac",
  user_identifier_key: "jane_doe",
  connected_account_ids: ["c35ecf64-474a-466a-95a6-7b35cb4c8bb4"],
  connect_webview_ids: ["dad03fb2-f801-449c-ab88-0529728c7c38"],
  user_identity_id: "bde98963-3615-4e92-943e-17de3017232b",
});

/*
// void
*/

200

{
  "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"
  },
  "ok": true
}

Authorizations

api_keypat_with_workspaceconsole_session_with_workspace

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

client_session_id · string

ID of the client session to which you want to grant access to resources.

connect_webview_ids · string[]

IDs of the Connect Webviews that you want to associate with the client session.

connected_account_ids · string[]

IDs of the connected accounts that you want to associate with the client session.

user_identifier_key · string

Your user ID for the user that you want to associate with the client session.

user_identity_id · string

ID of the user identity that you want to associate with the client session.

user_identity_ids · string[] · deprecated

IDs of the user identities that you want to associate with the client session.

Required array length: 1 element

Response

200

application/json

OK

client_session · object · required

Represents a client session. If you want to restrict your users' access to their own devices, use client sessions.

Show child attributes

ok · boolean · required