specs/models/M_APIT

API Tokens

NOTICE: This section was previously M_BOTS

A Token is a combo of an API key and a secret alphanumeric code that allows anybody to read or write to Tulip's database. It must be manually created by a user with access to the API Tokens page- there are no "default" tokens.

Access is controlled via the API key and secret, and can always be turned off at any point. The "secret" will only be displayed once, when the token is created.

Fields

FieldDescription
NameA text value for the user-facing name
ImageAn optional image uploaded by the user
ScopesThe permissions for the token. Possibilities include any combination of: read access for apps, machines, tables, and table queries, as well as write access for events, attributes, machines, tables, table queries, and users.
Workspace or Account-LevelA boolean that determines whether the scopes apply to a single workspace or can be used across the entire account
API KeyAn automatically generated unique alphanumeric string ID for the token
SecretA text value that will be required every time the API is called. Revealed once during token creation, then the user must manually add this key to the service that is calling the Tulip API.
Auth HeaderAn automatically generated text value to be included in the header of requests to the Tulip API
CreatorThe user that created the token
Create DateThe date that the token was created
EnabledBoolean value for whether the token is active or not

Tests

No tests

Requirements

No requirements