# Auth

## Validate current API key

`client.auth.validate(RequestOptionsoptions?): 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](/using-the-api/scopes/):** None

**[Rate limit category](/using-the-api/rate-limits/):** Read

### Returns

- `AuthValidateResponse`

  - `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`.

    - `"user"`

    - `"workspace"`

  - `tokenType: "api_key"`

    Credential family, always `api_key`.

    - `"api_key"`

### Example

```typescript
import Lightfield from 'lightfield';

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

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

console.log(authValidateResponse.active);
```

#### Response

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

## Domain Types

### Auth Validate Response

- `AuthValidateResponse`

  - `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`.

    - `"user"`

    - `"workspace"`

  - `tokenType: "api_key"`

    Credential family, always `api_key`.

    - `"api_key"`