API Keys
Prov1.0.0Create, roll and revoke API keys with scopes, usage, stale warnings and a show-once secret.
Build for your project
Code/install build
Usage
Import it and pass your content. The props that matter most are listed next.
Example
import { ApiKeys, type ApiKey } from "@/components/ui/notchset/blocks/api-keys";
export function Keys({ keys }: { keys: ApiKey[] }) {
return (
<ApiKeys
keys={keys}
scopes={[{ value: "runs:read" }, { value: "runs:write" }, { value: "deploy:prod", danger: true }]}
onCreate={async (draft) => {
const r = await fetch("/api/keys", { method: "POST", body: JSON.stringify(draft) });
if (!r.ok) throw new Error("create failed");
return r.json(); // { key, secret }
}}
onRoll={(key) => fetch(`/api/keys/${key.id}/roll`, { method: "POST" }).then((r) => r.json())}
onRevoke={(key) => fetch(`/api/keys/${key.id}`, { method: "DELETE" })}
/>
);
}Props
keys–{ id, name, env, suffix, scopes, lastUsed, stale?, created, requests, restriction, expiry, expiringSoon? }[]Only the last four characters of a secret reach the client. requests is 14 daily counts.
scopes–{ value, danger? }[]The scopes to offer; danger ones turn signal when picked.
onCreate–({ name, env, scopes, expiry }) => Promise<{ key, secret }>Create on your server; the secret is shown once and dropped on DONE.
onRoll / onRevoke–(key) => Promise<key> / (key) => PromiseRoll resolves with the updated key; revoke is confirmed inline first.
expiries / note–string[] / ReactNodeExpiry choices (default 30 D, 90 D, NEVER) and the line under the title.
Anatomy
- Created, rolled and revoked keys show locally until your data refreshes.
- The secret lives only in the reveal step and is dropped on DONE.
- Folded groups keep counts and warnings in their headers.
ApiKeysdata-slot="api-keys"The header, the create panel and the LIVE and TEST groups.
Source
components/ui/notchset/blocks/api-keys.tsx
This component is included with Pro.
Try the live preview above. Get Pro to install the source.
Build for your project
Code/install build
Installation
pnpm dlx shadcn@latest add @beautiful-ui-pro/api-keysNeeds your registry key. Your components.json style picks the Base UI or Radix build: radix-*, new-york and default get Radix, base-* gets Base UI.
Styles didn't apply?
The CLI adds the styles to the CSS file named in components.json (tailwind.css). Check that it points at your global stylesheet, that the project uses Tailwind CSS v4, and that the file is imported in your root layout. Installed by hand: paste styles.css into that file.
For coding agents
Give your coding assistant the Markdown guide instead of screenshots.
Use it for
- A developer settings page where customers manage server-side keys
- Products that need scoped, expiring keys with a show-once secret
Use something else when
- Personal OAuth connections: use Integrations
- Publishable client-side keys that aren't secret: a copy field is enough
Mistakes to avoid
- Never return or log the full secret anywhere but the create response
- Flag keys unused for 30 days so they get revoked
Agents find it by
- api keys, secret keys, access tokens, developer settings, create api key, revoke key, rotate key, roll key, scopes, Notchset
Where agents read it
- Guide for this component: https://beautiful-ui.dev/md/api-keys.md
- Every component, for tools without MCP: /llms.txt
- MCP server:
https://beautiful-ui.dev/api/mcp(setup)
Behaviour
Keyboard
- Enter
- Create from the name field
- ← →
- Environment and expiry
- Space
- Toggle a scope or the saved check
Accessibility
- Groups and keys are buttons with aria-expanded; folded content is inert
- Scopes are checkboxes; environment and expiry are radio groups (the Segmented Control)
- Results (created, rolled, revoked, blocked) are announced in the status line; DONE is aria-disabled until you confirm the key is saved
Motion
- Create
- The panel unrolls in 420ms; CREATE KEY's + turns into ×
- Reveal
- The secret rises in; the saved check draws
- Roll
- The scanner, then the last four characters roll
- Invalid
- A signal edge and a short shake on the name
Responsive
- Under 640px (container width) a key stacks its name, scopes and last use; the create form stacks under 520px.
Performance
- Plain rows and small SVG strips; nothing runs while idle.
Changelog
v1.0.0 · 2026-10-04
First release
Part of
Included with Pro
Pro is in early access.
