Skip to content

Disambiguate the API Keys feature from Clerk's Publishable and Secret Keys#3491

Open
manovotny wants to merge 6 commits into
mainfrom
manovotny/single-rambutan
Open

Disambiguate the API Keys feature from Clerk's Publishable and Secret Keys#3491
manovotny wants to merge 6 commits into
mainfrom
manovotny/single-rambutan

Conversation

@manovotny

Copy link
Copy Markdown
Contributor

🔎 Previews:

What does this solve? What changed?

"API keys" means two different things in the Clerk docs: the Publishable Key and Secret Key that connect your app to Clerk (copied from the API keys page in the Clerk Dashboard), and the API Keys feature that lets your users create keys for accessing your own app's API. Readers landing on either set of pages can easily conflate the two.

  • Adds a new _partials/machine-auth/api-keys-disambiguation.mdx partial — a note pointing readers who are looking for their Publishable and Secret Keys to the Clerk Dashboard and the environment variables reference — and includes it on the API Keys guide and all seven JS Backend SDK apiKeys reference pages (create(), delete(), get(), list(), revoke(), update(), verify()).
  • Adds the reverse-direction note to the Clerk environment variables reference, pointing readers who want user-generated keys to the API Keys feature.
  • Mentions in the Next.js quickstart that, after claiming your keys, they're available any time on the API keys page in the Clerk Dashboard.

Deadline

  • No rush

Other resources

  • N/A

… Keys

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
clerk-docs Ready Ready Preview Jul 3, 2026 4:25pm

Request Review

manovotny and others added 2 commits July 1, 2026 17:55
Resolves conflicts with the Typedoc migration of the Backend SDK API
keys reference pages: keeps main's Typedoc-driven structure and moves
the disambiguation include to the top of each page.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…claim note

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@manovotny manovotny marked this pull request as ready for review July 2, 2026 15:20
@manovotny manovotny requested a review from a team as a code owner July 2, 2026 15:20
Comment thread docs/getting-started/quickstart.mdx Outdated
Comment thread docs/_partials/machine-auth/api-keys-disambiguation.mdx Outdated

@SarahSoutoul SarahSoutoul left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noticed the callout note isn't in the getSecret() method but all the others? On purpose?

Co-authored-by: Sarah Soutoul <sarah@clerk.dev>
manovotny and others added 2 commits July 3, 2026 11:23
… partial

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
The page was added on main by the Typedoc migration (#3445) after this
branch's original change, so it missed the include the other API keys
reference pages received.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@manovotny

Copy link
Copy Markdown
Contributor Author

Noticed the callout note isn't in the getSecret() method but all the others? On purpose?

Good catch — not on purpose. getSecret() was added on main in the Typedoc migration (#3445) after this branch was cut, so it missed the include when I merged main in. Added in 97932e5.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants