Skip to main content
Version: Developer

Join a shared session as a participant

POST 

/api/session/shares/:share_id/participants

A user joins as themselves and gets the participant view. An API key holding USERS_AUTH_SESSION is admitted as a new anonymous participant and also gets that identity's user_id, username, login JWT (session_token) and browser connect_url. Anonymous admission accepts an optional Idempotency-Key header: when supplied, the same key replays the original participant and token, while a different request under a used key is 409. Without the header, every request creates a new anonymous participant. More anonymous users than auth.api_anonymous_creation_limit per hour is 429.

Request​

Responses​

Successful Response

Response Headers
    Cache-Control

    Always no-store.

    Pragma

    Always no-cache.