Subscriber Tokens

Create Subscriber token

Changed on

Creates a Subscriber Access Token (SAT) for a known Subscriber, identified by reference, and optionally updates that subscriber's profile. Call it from your server when a Browser SDK or other subscriber client needs to sign in. Tokens expire after two hours by default; bind one to a client with fingerprint and sat:refresh when that client should refresh its own access, or use Refresh Subscriber token from your backend.

Use Create Subscriber guest token for temporary access limited to selected resource addresses, or Create API token for server-side REST authentication.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Voice, Messaging, Fax, or Video.

Learn more about API scopes.

post/api/fabric/subscribers/tokens

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/subscribers/tokens
  • Auth
    HTTP basic

Request body

referencestring required

A string that uniquely identifies the subscriber. Often it's an email, but can be any other string.

expire_atinteger

A unixtime (the number of seconds since 1970-01-01 00:00:00) at which the token should no longer be valid. Defaults to 'two hours from now'

application_idstring uuid

Universal Unique Identifier.

passwordstring

Set or update the subscriber's password. Omit this field or pass an empty string if you don't want to update the password.

fingerprintstring

Binds the token to a specific device or browser session, letting the holder refresh it without going through your backend. The Browser SDK generates this value automatically when starting a session — forward it to your backend when requesting a token, so tie the token to that client.

Without fingerprint, your backend can still refresh the token using the companion refresh_token returned in this response.

scope'sat:refresh'

Grants the token's holder permission to refresh it directly from the Browser SDK client. Pair with fingerprint to bind the token to a device.

Without this scope, your backend can still refresh the token using the companion refresh_token. If sat:refresh is set without fingerprint, the token's lifetime is limited to 60 seconds.

first_namestring

Set or update the first name of the subscriber.

last_namestring

Set or update the last name of the subscriber.

display_namestring

Set or update the display name of the subscriber.

job_titlestring

Set or update the job title of the subscriber.

time_zonestring

Set or update the time zone of the subscriber.

countrystring

Set or update the country of the subscriber.

region'us-central'

A routing override that controls which regional cluster the SDK connects to.

company_namestring

Set or update the company name of the subscriber.

Example request

{
  "reference": "john.doe@example.com",
  "expire_at": 1693823284,
  "password": "password123",
  "fingerprint": "Vg1h7IDV3AR6kTpCkZPHOVs32B81DX1naHiHbYoKXgY",
  "scope": "sat:refresh",
  "first_name": "John",
  "last_name": "Doe",
  "display_name": "John Doe",
  "job_title": "Software Engineer",
  "time_zone": "America/New_York",
  "country": "US",
  "region": "us-central",
  "company_name": "SignalWire"
}

Response

The request has succeeded.

subscriber_idstring uuid required

Universal Unique Identifier.

tokenstring jwt required
refresh_tokenstring jwt required

Changes

Some revisions have not been checked yet.