Skip to content
Lightfield Lightfield
API Reference
Auth

Validate current API key

auth.validate() -> AuthValidateResponse
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
class AuthValidateResponse: …
active: bool

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

scopes: List[str]

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

subject_type: Literal["user", "workspace"]

Whether the API key belongs to a user or workspace.

One of the following:
"user"
"workspace"
token_type: Literal["api_key"]

Credential family, always api_key.

Validate current API key

from lightfield import Lightfield

client = Lightfield(
    api_key="My API Key",
)
auth_validate_response = client.auth.validate()
print(auth_validate_response.active)
{
  "active": true,
  "scopes": [
    "string"
  ],
  "subjectType": "user",
  "tokenType": "api_key"
}
Returns Examples
{
  "active": true,
  "scopes": [
    "string"
  ],
  "subjectType": "user",
  "tokenType": "api_key"
}