Skip to content
Lightfield Lightfield
API Reference

Auth

Auth helper to validate the current token and describe the access it grants. This endpoint is currently only available for API keys.

Validate current API key
$ lightfield auth validate
GET/v1/auth/validate
ModelsExpand 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"