@seamapi/http - v2.1.0
    Preparing search index...

    Type Alias ClientSession

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

    You create each client session with a custom user_identifier_key. Normally, the user_identifier_key is a user ID that your application provides.

    When calling the Seam API from your backend using an API key, you can pass the user_identifier_key as a parameter to limit results to the associated client session. For example, /devices/list?user_identifier_key=123 only returns devices associated with the client session created with the user_identifier_key 123.

    A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.

    See also Get Started with React.

    type ClientSession = {
        client_session_id: string;
        connect_webview_ids: string[];
        connected_account_ids: string[];
        created_at: string;
        customer_key?: string;
        device_count: number;
        expires_at: string;
        token: string;
        user_identifier_key: string | null;
        user_identity_id?: string;
        user_identity_ids: string[];
        workspace_id: string;
    }
    Index
    client_session_id connect_webview_ids connected_account_ids created_at customer_key? device_count expires_at token user_identifier_key user_identity_id? user_identity_ids workspace_id
    client_session_id: string

    ID of the client session.

    connect_webview_ids: string[]

    IDs of the Connect Webviews associated with the client session.

    connected_account_ids: string[]

    IDs of the connected accounts associated with the client session.

    created_at: string

    Date and time at which the client session was created.

    customer_key?: string

    Customer key associated with the client session.

    device_count: number

    Number of devices associated with the client session.

    expires_at: string

    Date and time at which the client session expires.

    token: string

    Client session token associated with the client session.

    user_identifier_key: string | null

    Your user ID for the user associated with the client session.

    user_identity_id?: string

    ID of the user identity associated with the client session.

    user_identity_ids: string[]

    IDs of the user identities associated with the client session.

    Use user_identity_id instead.

    workspace_id: string

    ID of the workspace associated with the client session.

    Settings
    Member Visibility

    On This Page
    Properties