Tinybird · Schema

Tinybird Token

Schema for a Tinybird authentication Token with scoped permissions

AnalyticsDataReal-TimeSQLStreaming

Properties

Name Type Description
id string Unique identifier for the token
name string Human-readable name for the token
token string The actual token value used for API authentication
scopes array List of permission scopes granted to this token
created_at string
View JSON Schema on GitHub

JSON Schema

tinybird-token-schema.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tinybird/main/json-schema/tinybird-token-schema.json",
  "title": "Tinybird Token",
  "description": "Schema for a Tinybird authentication Token with scoped permissions",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the token"
    },
    "name": {
      "type": "string",
      "description": "Human-readable name for the token"
    },
    "token": {
      "type": "string",
      "description": "The actual token value used for API authentication"
    },
    "scopes": {
      "type": "array",
      "description": "List of permission scopes granted to this token",
      "items": {
        "type": "object",
        "properties": {
          "type": {
            "type": "string",
            "description": "Scope type (e.g., DATASOURCES:READ, PIPE:CREATE, ADMIN)"
          },
          "resource": {
            "type": "string",
            "description": "Specific resource the scope applies to"
          },
          "filter": {
            "type": "string",
            "description": "Row-level filter condition for data access control"
          }
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time"
    }
  },
  "required": ["id", "name", "token"]
}