Token

  • allowedIps
    Type: array of string

    Whitelist of IPv4/IPv6 addresses or CIDR ranges; empty means unrestricted

  • boostId
    Type: string
    read-only

    Globally unique boost.space identifier for this record (UUID-like)

  • created
    Type: stringFormat: date-time
    read-only

    Creation timestamp

  • createdUserId
    Type: integer
    read-only

    ID of user who created this record

  • customModuleScoped
    Type: boolean
    read-only

    Whether the token was created with a custom module scope; it stays true after all its scoped modules are deleted, so such a token reaches no custom module data

  • description
    Type: string

    Human-readable description of the token's purpose

  • id
    Type: integer
    read-only

    Unique identifier - primary key

  • mcp
    Type: boolean

    When true, this token is an MCP (Model Context Protocol) token for AI integrations

  • permissions
    Type:

    Per-module CRUD permissions granted to this token

    Properties: 10
  • priority
    Type: integer

    Default conflict-resolution priority across tokens; lower value takes precedence

  • scope
    Type: object

    Data scope of this token, one key per dimension. Immutable after creation — to change it, create a new token.

    Properties: 1
  • scopedTypes
    Type: array of string
    read-only

    Scope dimensions that restrict this token, derived server-side. A dimension stays listed even after all its targets are deleted, so such a token can access no data of that dimension at all.

  • token
    Type: string
    read-only

    Bearer token value used in the Authorization header

  • userId
    Type: integer
    read-only

    ID of the user this token authenticates on behalf of

Previous
Array of multiple Token objects
Next
Token Permission