specs/models/M_API_TOKENS
API Tokens
An "API 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" API 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 API token is created.
Fields
| Field | Description |
|---|---|
| Name | A text value for the user-facing name |
| Image | An optional image uploaded by the user |
| Scopes | The permissions for the API 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. |
| API Key | An automatically generated unique alphanumeric string ID for the API token |
| Secret | A text value that will be required every time the API is called. Revealed once during API token creation, then the user must manually add this key to the service that is calling the Tulip API. |
| Auth Header | An automatically generated text value to be included in the header of requests to the Tulip API |
| Creator | The user that created the API token |
| Create Date | The date that the API token was created |
| Enabled | Boolean value for whether the API token is active or not |
Tests
| ID | Name |
|---|---|
| QA-T579 | API Tokens : 01 - Creating, Editing, and Disabling API Tokens |
| QA-T1191 | User Management: 16 - Logging out of one tab logs out of all tabs |
| QA-T1282 | Creating Global and Worksapce-Scoped API Tokens |
Requirements
No requirements