Validate current API key

client.auth.validate(?): AuthValidateResponse { active, scopes, subjectType, tokenType }

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

AuthValidateResponse { active, scopes, subjectType, tokenType }

active: boolean

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

scopes: Array<string>

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

subjectType: "user" | "workspace"

Whether the API key belongs to a user or workspace.

One of the following:

"user"

"workspace"

tokenType: "api_key"

Credential family, always api_key.

Validate current API key

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const authValidateResponse = await client.auth.validate();

console.log(authValidateResponse.active);

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

Returns Examples

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