Skip to main content

Generate a new PubSub Token

POST 
/tokens

Generate a PubSub Token to be used to authenticate clients to the PubSub Service.

Permissions​

The API token must include the following scopes: PubSub.

Request​

Body

required

    ttl integerrequired

    The maximum time, in minutes, that the access token will be valid for. Between 1 and 43,200 (30 days).

    Example: 15

    channels

    object

    required

    Each channel with write and read objects with boolean as values. Max of 500 channels inside main channels. Either read, write, or both are required inside each channel and default to false. Each channel name can be up to 250 characters. Must be valid JSON.

    property name*

    object

    The key for this object represents the name of the channel. The inner properties specify its permissions.

    read boolean
    Example: true
    write boolean
    Example: false
    member_id string

    The unique identifier of the member. Up to 250 characters. If not specified, a random UUID will be generated.

    Example: John Doe
    state object

    An arbitrary JSON object available to store stateful application information in. Must be valid JSON and have a maximum size of 2,000 characters.

    Example: {"display_name":"Joe","an_array":["foo","bar","baz"]}

Responses​

OK

Schema

    token string

    A PubSub Token to be used to authenticate clients to the PubSub Service.

    Example: eyJ0eXAiOiJWUlQiLCJhbGciOiJIUzUxMiJ9.eyJpYXQiOjE2MjIxMjAxMjMsI...wMCwicnNlIjo5MDB9-BqG-DqC5LhpsdMWEFjhVkTBpQ