Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_partials/machine-auth/api-keys-disambiguation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
> [!NOTE]
> Looking for the [Publishable Key](!publishable-key) and [Secret Key](!secret-key) you use to connect your own app to Clerk? Those are different from the API keys described here. You can copy them from the [**API keys**](https://dashboard.clerk.com/~/api-keys) page in the Clerk Dashboard, or learn more in the [Clerk environment variables](/docs/guides/development/clerk-environment-variables) reference.
2 changes: 1 addition & 1 deletion docs/getting-started/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ llm:

<SignedOut>
> [!IMPORTANT]
> To make configuration changes to your Clerk development instance, claim the Clerk keys that were generated for you by selecting **Configure your application** in the bottom right of your app. This will associate the application with your Clerk account.
> To make configuration changes to your Clerk development instance, claim the Clerk keys that were generated for you by selecting **Configure your application** in the bottom right of your app. This will associate the application with your Clerk account. Once claimed, you can find your [Publishable Key](!publishable-key) and [Secret Key](!secret-key) any time on the [**API keys**](https://dashboard.clerk.com/~/api-keys) page in the Clerk Dashboard.
</SignedOut>
</Steps>

Expand Down
3 changes: 3 additions & 0 deletions docs/guides/development/clerk-environment-variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ However, **it's recommended to use environment variables instead of these props

To access your Clerk app in your local project, you must specify your app's [Publishable Keys](!publishable-key) for use in the frontend, and [Secret Keys](!secret-key) for use in the backend.

> [!NOTE]
> These keys connect your app to Clerk. If you instead want your app's users to create their own API keys to access your app's API, see the [API keys feature](/docs/guides/development/machine-auth/api-keys).

<Tabs items={["General", "Vite"]}>
<Tab>
| Variable | Description |
Expand Down
2 changes: 2 additions & 0 deletions docs/guides/development/machine-auth/api-keys.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ For example, imagine you're building an application like ChatGPT and you want de

This guide demonstrates how to create API keys, list them, use them to authenticate requests, and revoke them when needed.

<Include src="_partials/machine-auth/api-keys-disambiguation" />

> [!NOTE]
> If you find that the use case being described does not fit what you are looking to accomplish with machine authentication, check out the [machine authentication overview](/docs/guides/development/machine-auth/overview) for more information on the different types of machine authentication that Clerk supports and what features are available for each type.

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/create.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`create()`'
description: Use the create() method to create an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/create" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/delete.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`delete()`'
description: Use the delete() method to delete an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/delete" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/get-secret.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`getSecret()`'
description: Use the getSecret() method to get the secret of an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/get-secret" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/get.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`get()`'
description: Use the get() method to get an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/get" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/list.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`list()`'
description: Use the list() method to get a list of API keys for the given user or Organization.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/list" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/revoke.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`revoke()`'
description: Use the revoke() method to revoke an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/revoke" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/update.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`update()`'
description: Use the update() method to update an API key.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

<Typedoc src="backend/api-keys-api/methods/update" />

## Usage
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/backend/api-keys/verify.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: '`verify()`'
description: Use the verify() method to verify an API key secret.
---

<Include src="_partials/machine-auth/api-keys-disambiguation" />

> [!NOTE]
> In most cases, you'll want to verify API keys using framework-specific helpers like `auth()` in Next.js, which handles the verification automatically. See the [verifying API keys](/docs/guides/development/verifying-api-keys) guide for more details.

Expand Down
Loading