Contains an Ably Token and its associated metadata.

Hierarchy

  • TokenDetails

Properties

capability: string

The capabilities associated with this Ably Token. The capabilities value is a JSON-encoded representation of the resource paths and associated operations. Read more about capabilities in the capabilities docs.

clientId?: string

The client ID, if any, bound to this Ably Token. If a client ID is included, then the Ably Token authenticates its bearer as that client ID, and the Ably Token may only be used to perform operations on behalf of that client ID. The client is then considered to be an identified client.

expires: number

The timestamp at which this token expires as milliseconds since the Unix epoch.

issued: number

The timestamp at which this token was issued as milliseconds since the Unix epoch.

token: string

The Ably Token itself. A typical Ably Token string appears with the form xVLyHw.A-pwh7wicf3afTfgiw4k2Ku33kcnSA7z6y8FjuYpe3QaNRTEo4.

Generated using TypeDoc