---
title: "Secret"
description: "The `Secret` entity."
section: "Reference"
group: "Types"
order: 185
---

## Definition

```ts
interface Secret {
  id: string;
  workspaceId: string;
  name: string;
  hint: string | null;
  metadata: Record<string, unknown>;
  createdBy: string;
  createdAt: string;
  updatedAt: string;
}
```

## Fields

| Field         | Type                      | Notes                                                                                                                             |
| ------------- | ------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `id`          | `string`                  | `readonly` `required`                                                                                                             |
| `workspaceId` | `string`                  | `required` — Workspace that owns this secret.                                                                                     |
| `name`        | `string`                  | `required` — Human-readable label, unique within the workspace.                                                                   |
| `hint`        | `string \| null`          | `required` — Masked preview of the value (e.g. "••••4242"). Server-derived; safe to display. Null when no hint could be computed. |
| `metadata`    | `Record<string, unknown>` | `required` — Arbitrary non-secret metadata (vendor, scopes, …). Never holds the secret value.                                     |
| `createdBy`   | `string`                  | `required` — User who created the secret.                                                                                         |
| `createdAt`   | `string`                  | `readonly` `required` — ISO-8601 timestamp of creation.                                                                           |
| `updatedAt`   | `string`                  | `readonly` `required` — ISO-8601 timestamp of the last update.                                                                    |