Sign in

v2

latestOpenAPI 3.1.02026-07-312303692.4 MB
Stream Authentication

Get Stream Portal Access

Use this function to get magic links (and authentication codes) for connecting your users to the Stream Consumer Portal.

post/api/v1/auth/stream-portal-access/{stream_id}

Path parameters

stream_idstring required

The Stream's ID or UID.

Example:unique-identifier

The Stream's ID or UID.

Headers

idempotency-keystring

The request's idempotency key

Request body

featureFlagsstring[]

The set of feature flags the created token will have access to.

expiryinteger nullable

How long the token will be valid for, in seconds.

Valid values are between 1 hour and 7 days. The default is 7 days.

sessionIdstring nullable

An optional session ID to attach to the token.

When expiring tokens with "Expire All", you can include the session ID to only expire tokens that were created with that session ID.

Example request

{
  "featureFlags": [],
  "sessionId": "user_1FB8"
}

Response

urlstring uri required
tokenstring required

Example response

{
  "url": "https://app.svix.com/login#key=eyJhcHBJZCI6ICJhcHBfMXRSdFl",
  "token": "appsk_kV3ts5tKPNJN4Dl25cMTfUNdmabxbX0O"
}