Clerk Product Documentation llms.txt

The actual file

Source Markdown

The saved llms.txt text, displayed as source. The file belongs to its publisher; the live endpoint may change.

Showing the first 18000 characters. Load the complete file to read the remainder.

# Clerk

Search these docs: `https://clerk.com/docs/search.md?q=<query>` (optional `&sdk=<sdk>`). Append `.md` to a docs page URL for markdown (the API references are OpenAPI specs instead).

## Docs

- [Clerk templates and examples](https://clerk.com/docs/templates.md): Browse Clerk-maintained quickstarts, starter templates, demos, and example applications.
- [Clerk CLI](https://clerk.com/docs/cli.md): Learn how to use the Clerk CLI to set up authentication, manage configuration, and integrate with AI agents.
- [Welcome to Clerk Docs](https://clerk.com/docs.md): Add complete user management to your application in minutes.
- [Maintenance Mode](https://clerk.com/docs/maintenance-mode.md): Learn about Clerk's Maintenance Mode.
- [Pin a Clerk SDK](https://clerk.com/docs/pinning.md): Learn how to pin a Clerk SDK to a specific version.
- [Core concepts](https://clerk.com/docs/getting-started/core-concepts.md): Learn about the main concepts and objects that drive Clerk's powerful authentication and user management system.
- [Set up your Clerk account](https://clerk.com/docs/getting-started/quickstart/setup-clerk.md): Set up a Clerk account and application with the Clerk CLI or in the Clerk Dashboard.
- [Quickstarts](https://clerk.com/docs/getting-started/quickstart/overview.md): See the getting started guides and tutorials.
- [Next.js Quickstart (Pages Router)](https://clerk.com/docs/getting-started/quickstart/pages-router.md): Add authentication and user management to your Next.js app with Clerk.
- [Chrome Extension Quickstart (JavaScript)](https://clerk.com/docs/getting-started/quickstart/chrome-extension-js.md): Add authentication and user management to your Chrome Extension with Clerk using plain TypeScript and esbuild.
- [SDK References](https://clerk.com/docs/reference/overview.md): Learn about the Clerk and community SDK's available for integrating Clerk into your application.
- [API Reference](https://clerk.com/docs/reference/api/overview.md): Access Clerk's Frontend, Backend, and Platform API reference documentation.
- [`clerkClient`](https://clerk.com/docs/reference/backend/overview.md): Use clerkClient to interact with Clerk's Backend API resources.
- [`authenticateRequest()`](https://clerk.com/docs/reference/backend/authenticate-request.md): Use the authenticateRequest() method to verify a token passed from the frontend.
- [`verifyToken()`](https://clerk.com/docs/reference/backend/verify-token.md): Use the verifyToken() method to verify a token signature.
- [`verifyWebhook()`](https://clerk.com/docs/reference/backend/verify-webhook.md): Use the verifyWebhook() method to verify a webhook signature.
- [`deleteAllowlistIdentifier()`](https://clerk.com/docs/reference/backend/allowlist/delete-allowlist-identifier.md): Use the deleteAllowlistIdentifier() method to delete an allowlist identifier.
- [`getAllowlistIdentifierList()`](https://clerk.com/docs/reference/backend/allowlist/get-allowlist-identifier-list.md): Use the getAllowlistIdentifierList() method to get a list of allowlist identifiers.
- [`createAllowlistIdentifier()`](https://clerk.com/docs/reference/backend/allowlist/create-allowlist-identifier.md): Use the createAllowlistIdentifier() method to add a new identifier to the allowlist.
- [`create()`](https://clerk.com/docs/reference/backend/agent-tasks/create.md): Use the create() method to create an Agent Task.
- [`revoke()`](https://clerk.com/docs/reference/backend/agent-tasks/revoke.md): Use the revoke() method to revoke an Agent Task.
- [`create()`](https://clerk.com/docs/reference/backend/api-keys/create.md): Use the create() method to create an API key.
- [`delete()`](https://clerk.com/docs/reference/backend/api-keys/delete.md): Use the delete() method to delete an API key.
- [`list()`](https://clerk.com/docs/reference/backend/api-keys/list.md): Use the list() method to get a list of API keys for the given user or Organization.
- [`revoke()`](https://clerk.com/docs/reference/backend/api-keys/revoke.md): Use the revoke() method to revoke an API key.
- [`getSecret()`](https://clerk.com/docs/reference/backend/api-keys/get-secret.md): Use the getSecret() method to get the secret of an API key.
- [`get()`](https://clerk.com/docs/reference/backend/api-keys/get.md): Use the get() method to get an API key.
- [`update()`](https://clerk.com/docs/reference/backend/api-keys/update.md): Use the update() method to update an API key.
- [`verify()`](https://clerk.com/docs/reference/backend/api-keys/verify.md): Use the verify() method to verify an API key secret.
- [`getOrganizationBillingSubscription()`](https://clerk.com/docs/reference/backend/billing/get-organization-billing-subscription.md): Use the getOrganizationBillingSubscription() method to get an Organization's Billing Subscription.
- [`extendSubscriptionItemFreeTrial()`](https://clerk.com/docs/reference/backend/billing/extend-subscription-item-free-trial.md): Use the extendSubscriptionItemFreeTrial() method to extend the free trial period of a Subscription Item.
- [`cancelSubscriptionItem()`](https://clerk.com/docs/reference/backend/billing/cancel-subscription-item.md): Use the cancelSubscriptionItem() method to cancel a Subscription Item.
- [`getUserBillingSubscription()`](https://clerk.com/docs/reference/backend/billing/get-user-billing-subscription.md): Use the getUserBillingSubscription() method to get a user's Billing Subscription.
- [`getPlanList()`](https://clerk.com/docs/reference/backend/billing/get-plan-list.md): Use the getPlanList() method to get a list of Billing Plans.
- [`getClientList()`](https://clerk.com/docs/reference/backend/client/get-client-list.md): Retrieves the list of clients.
- [`verifyClient()`](https://clerk.com/docs/reference/backend/client/verify-client.md): Use the verifyClient() method to get a client for a given session token, if the session is active.
- [`getClient()`](https://clerk.com/docs/reference/backend/client/get-client.md): Use the getClient() method to get a single client by its ID.
- [`delete()`](https://clerk.com/docs/reference/backend/domains/delete.md): Use the delete() method to delete a domain other than the active one.
- [`list()`](https://clerk.com/docs/reference/backend/domains/list.md): Use the list() method to list the domains for the instance.
- [`update()`](https://clerk.com/docs/reference/backend/domains/update.md): Use the update() method to update a domain.
- [`deleteDomain()`](https://clerk.com/docs/reference/backend/domains/delete-domain.md): Use the deleteDomain() method to delete a domain other than the active one.
- [`add()`](https://clerk.com/docs/reference/backend/domains/add.md): Use the add() method to add a new domain to the instance.
- [`updateEmailAddress()`](https://clerk.com/docs/reference/backend/email-addresses/update-email-address.md): Use the updateEmailAddress() method to update an email address.
- [`deleteEmailAddress()`](https://clerk.com/docs/reference/backend/email-addresses/delete-email-address.md): Use the deleteEmailAddress() method to delete an email address.
- [`getEmailAddress()`](https://clerk.com/docs/reference/backend/email-addresses/get-email-address.md): Use the getEmailAddress() method to get an email address by its ID.
- [`createEmailAddress()`](https://clerk.com/docs/reference/backend/email-addresses/create-email-address.md): Use the createEmailAddress() method to create an email address for the specified user.
- [`updateEnterpriseConnection()`](https://clerk.com/docs/reference/backend/enterprise-connections/update-enterprise-connection.md): Use the updateEnterpriseConnection() method to update an enterprise connection.
- [`getEnterpriseConnection()`](https://clerk.com/docs/reference/backend/enterprise-connections/get-enterprise-connection.md): Use the getEnterpriseConnection() method to get an enterprise connection.
- [`getEnterpriseConnectionList()`](https://clerk.com/docs/reference/backend/enterprise-connections/get-enterprise-connection-list.md): Use the getEnterpriseConnectionList() method to get a list of enterprise connections.
- [`deleteEnterpriseConnection()`](https://clerk.com/docs/reference/backend/enterprise-connections/delete-enterprise-connection.md): Use the deleteEnterpriseConnection() method to delete an enterprise connection.
- [`createEnterpriseConnection()`](https://clerk.com/docs/reference/backend/enterprise-connections/create-enterprise-connection.md): Use the createEnterpriseConnection() method to create an enterprise connection.
- [`updateRestrictions()`](https://clerk.com/docs/reference/backend/instance/update-restrictions.md): Use the updateRestrictions() method to update the restriction settings of the current instance.
- [`updateOrganizationSettings()`](https://clerk.com/docs/reference/backend/instance/update-organization-settings.md): Use the updateOrganizationSettings() method to update the Organization-related settings of the current instance.
- [`get()`](https://clerk.com/docs/reference/backend/instance/get.md): Use the get() method to get the given instance.
- [`getOrganizationSettings()`](https://clerk.com/docs/reference/backend/instance/get-organization-settings.md): Use the getOrganizationSettings() method to get the Organization-related settings of the current instance.
- [`update()`](https://clerk.com/docs/reference/backend/instance/update.md): Use the update() method to update the current instance.
- [`revokeInvitation()`](https://clerk.com/docs/reference/backend/invitations/revoke-invitation.md): Use the revokeInvitation() method to revoke an invitation.
- [`getInvitationList()`](https://clerk.com/docs/reference/backend/invitations/get-invitation-list.md): Use the getInvitationList() method to get a list of non-revoked invitations for your application.
- [`deleteInvitation()`](https://clerk.com/docs/reference/backend/invitations/delete-invitation.md): Use the deleteInvitation() method to permanently delete an invitation and its stored invitation email.
- [`createInvitation()`](https://clerk.com/docs/reference/backend/invitations/create-invitation.md): Use the createInvitation() method to create a new invitation for the given email address, and send the invitation email.
- [`createInvitationBulk()`](https://clerk.com/docs/reference/backend/invitations/create-invitation-bulk.md): Use the createInvitationBulk() method to create multiple invitations for the given email addresses, and send the invitation emails.
- [`verify()`](https://clerk.com/docs/reference/backend/m2m-tokens/verify.md): Use the verify() method to verify an M2M token.
- [`revokeToken()`](https://clerk.com/docs/reference/backend/m2m-tokens/revoke-token.md): Use the revokeToken() method to revoke a M2M token.
- [`createToken()`](https://clerk.com/docs/reference/backend/m2m-tokens/create-token.md): Use the createToken() method to create a M2M token.
- [`list()`](https://clerk.com/docs/reference/backend/m2m-tokens/list.md): Use the list() method to get a list of M2M tokens for the given machine.
- [`delete()`](https://clerk.com/docs/reference/backend/machines/delete.md): Use the delete() method to delete a machine.
- [`createScope()`](https://clerk.com/docs/reference/backend/machines/create-scope.md): Use the createScope() method to create a machine scope.
- [`create()`](https://clerk.com/docs/reference/backend/machines/create.md): Use the create() method to create a machine.
- [`deleteScope()`](https://clerk.com/docs/reference/backend/machines/delete-scope.md): Use the deleteScope() method to delete a machine scope.
- [`update()`](https://clerk.com/docs/reference/backend/machines/update.md): Use the update() method to update a machine.
- [`rotateSecretKey()`](https://clerk.com/docs/reference/backend/machines/rotate-secret-key.md): Use the rotateSecretKey() method to rotate a machine's secret key.
- [`list()`](https://clerk.com/docs/reference/backend/machines/list.md): Use the list() method to get a list of machines for the instance.
- [`get()`](https://clerk.com/docs/reference/backend/machines/get.md): Use the get() method to get the given machine.
- [`getSecretKey()`](https://clerk.com/docs/reference/backend/machines/get-secret-key.md): Use the getSecretKey() method to get a machine secret key.
- [`update()`](https://clerk.com/docs/reference/backend/oauth-applications/update.md): Use the update() method to update an OAuth application.
- [`rotateSecret()`](https://clerk.com/docs/reference/backend/oauth-applications/rotate-secret.md): Use the rotateSecret() method to rotate the OAuth application's client secret.
- [`revokeToken()`](https://clerk.com/docs/reference/backend/oauth-applications/revoke-token.md): Use the revokeToken() method to revoke an OAuth application token.
- [`list()`](https://clerk.com/docs/reference/backend/oauth-applications/list.md): Use the list() method to get a list of OAuth applications for an instance.
- [`delete()`](https://clerk.com/docs/reference/backend/oauth-applications/delete.md): Use the delete() method to delete an OAuth application.
- [`create()`](https://clerk.com/docs/reference/backend/oauth-applications/create.md): Use the create() method to create an OAuth application.
- [`get()`](https://clerk.com/docs/reference/backend/oauth-applications/get.md): Use the get() method to get an OAuth application.
- [`replaceOrganizationMetadata()`](https://clerk.com/docs/reference/backend/organization/replace-organization-metadata.md): Use the replaceOrganizationMetadata() method to fully replace the metadata associated with the specified Organization.
- [`createOrganizationInvitation()`](https://clerk.com/docs/reference/backend/organization/create-organization-invitation.md): Use the createOrganizationInvitation() method to create an invitation for new users to join an Organization.
- [`getOrganizationMembershipList()`](https://clerk.com/docs/reference/backend/organization/get-organization-membership-list.md): Use the getOrganizationMembershipList() method to get a list of memberships for an Organization.
- [`getOrganizationList()`](https://clerk.com/docs/reference/backend/organization/get-organization-list.md): Use the getOrganizationList() method to get a list of Organizations.
- [`getOrganizationInvitation()`](https://clerk.com/docs/reference/backend/organization/get-organization-invitation.md): Use the getOrganizationInvitation() method to get an Organization invitation.
- [`getInstanceOrganizationMembershipList()`](https://clerk.com/docs/reference/backend/organization/get-instance-organization-membership-list.md): Use the getInstanceOrganizationMembershipList() method to get the list of Organization Memberships for a given Organization.
- [`getOrganization()`](https://clerk.com/docs/reference/backend/organization/get-organization.md): Use the getOrganization() method to get a single Organization.
- [`getOrganizationInvitationList()`](https://clerk.com/docs/reference/backend/organization/get-organization-invitation-list.md): Use the getOrganizationInvitationList() method to get a list of Organization invitations.
- [`updateOrganization()`](https://clerk.com/docs/reference/backend/organization/update-organization.md): Use the updateOrganization() method to update an Organization's name.
- [`deleteOrganizationMembership()`](https://clerk.com/docs/reference/backend/organization/delete-organization-membership.md): Use the deleteOrganizationMembership() method to remove a user from the specified Organization.
- [`updateOrganizationMetadata()`](https://clerk.com/docs/reference/backend/organization/update-organization-metadata.md): Use the updateOrganizationMetadata() method to update the metadata associated with a given Organization.
- [`createOrganizationDomain()`](https://clerk.com/docs/reference/backend/organization/create-organization-domain.md): Use the createOrganizationDomain() method to create a new Verified Domain for a given Organization.
- [`updateOrganizationMembership()`](https://clerk.com/docs/reference/backend/organization/update-organization-membership.md): Use the updateOrganizationMembership() method to update a user's Organization membership.
- [`getOrganizationDomainList()`](https://clerk.com/docs/reference/backend/organization/get-organization-domain-list.md): Use the getOrganizationDomainList() method to get the list of Verified Domains for a given Organization.
- [`updateOrganizationMembershipMetadata()`](https://clerk.com/docs/reference/backend/organization/update-organization-membership-metadata.md): Use the updateOrganizationMembershipMetadata() method to update the metadata associated with a user's Organization membership.
- [`createOrganizationInvitationBulk()`](https://clerk.com/docs/reference/backend/organization/create-organization-invitation-bulk.md): Use the createOrganizationInvitationBulk() method to create multiple invitations for new users to join an Organization.
- [`updateOrganizationLogo()`](https://clerk.com/docs/reference/backend/organization/update-organization-logo.md): Use the updateOrganizationLogo() method to update an Organization's logo.
- [`deleteOrganizationDomain()`](https://clerk.com/docs/reference/backend/organization/delete-organization-domain.md): Use the deleteOrganizationDomain() method to delete a Verified Domain for a given Organization.
- [`updateOrganizationDomain()`](https://clerk.com/docs/reference/backend/organization/update-organization-domain.md): Use the updateOrganizationDomain() method to update a Verified Domain for a given Organization.
- [`revokeOrganizationInvitation()`](https://clerk.com/docs/reference/backend/organization/revoke-organization-invitation.md): Use the revokeOrganizationInvitation() method to revoke an Organization invitation from a user for a specified Organization.
- [`deleteOrganizationLogo()`](https://clerk.com/docs/reference/backend/organization/delete-organization-logo.md): Use the deleteOrganizationLogo() method to delete an Organization's logo.
- [`createOrganizationMembership()`](https://clerk.com/docs/reference/backend/organization/create-organization-membership.md): Use the cr