API Reference

Auth

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Validate current API key

$ lightfield auth validate

GET/v1/auth/validate

Returns metadata for the current API key, including the subject type and granted public scopes. Use this endpoint to confirm a key is active before making scoped API requests.

Required scope: None

Rate limit category: Read

ReturnsExpand Collapse

auth_validate_response: object { active, scopes, subjectType, tokenType }

active: boolean

Whether the current API key is valid. Always true on successful responses.

scopes: array of string

Granted public scopes for the current API key. Empty when the key has full access.

subjectType: "user" or "workspace"

Whether the API key belongs to a user or workspace.

"user"

"workspace"

tokenType: "api_key"

Credential family, always api_key.

"api_key"

Validate current API key

CLI Tool

HTTP

TypeScript

Python

Go

CLI Tool

lightfield auth validate \
  --api-key 'My API Key'

200 example

{
  "active": true,
  "scopes": [
    "string"
  ],
  "subjectType": "user",
  "tokenType": "api_key"
}

Returns Examples

200 example

{
  "active": true,
  "scopes": [
    "string"
  ],
  "subjectType": "user",
  "tokenType": "api_key"
}