Clerk llms.txt · AI Docs Browser · mdream

[llms.txt Tools](https://mdream.dev/llms-txt/clerk/llms-txt)

# Clerk llms.txt

Browse Clerk documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools.

clerk.com/llms.txt

[Raw llms.txt](https://clerk.com/docs/llms.txt) [Raw llms-full.txt](https://clerk.com/llms-full.txt)

Copy Markdown [](https://clerk.com/llms.txt)

llms.txt

Docs

Clerk CLI

Welcome to Clerk Docs

Pin a Clerk SDK

Maintenance Mode

Core concepts

Set up your Clerk account

Quickstarts

Chrome Extension Quickstart (JavaScript)

Next.js Quickstart (Pages Router)

SDK References

API Reference

authenticateRequest()

clerkClient

verifyToken()

verifyWebhook()

updateEmailAddress()

createEmailAddress()

deleteEmailAddress()

getEmailAddress()

deleteDomain() (deprecated)

update()

delete()

list()

add()

deleteAllowlistIdentifier()

getAllowlistIdentifierList()

createAllowlistIdentifier()

create()

revoke()

getPlanList()

getUserBillingSubscription()

cancelSubscriptionItem()

extendSubscriptionItemFreeTrial()

getOrganizationBillingSubscription()

getClient()

getClientList() (deprecated)

verifyClient()

createToken()

verify()

list()

revokeToken()

get()

list()

create()

delete()

verify()

revoke()

update()

getSecret()

createBulk()

create()

delete()

invite()

list()

reject()

createInvitationBulk()

createInvitation()

getInvitationList()

revokeInvitation()

getOrganizationSettings()

get()

updateOrganizationSettings()

updateRestrictions()

update()

getEnterpriseConnection()

updateEnterpriseConnection()

createEnterpriseConnection()

deleteEnterpriseConnection()

getEnterpriseConnectionList()

createRedirectUrl()

deleteRedirectUrl()

getRedirectUrlList()

getRedirectUrl()

rotateSecret()

update()

get()

list()

create()

revokeToken()

delete()

rotateSecretKey()

deleteScope()

delete()

update()

get()

list()

getSecretKey()

createScope()

create()

createPhoneNumber()

deletePhoneNumber()

getPhoneNumber()

updatePhoneNumber()

deleteOrganizationMembership()

deleteOrganization()

getInstanceOrganizationMembershipList()

getOrganizationDomainList()

getOrganizationInvitationList()

getOrganizationInvitation()

getOrganizationMembershipList()

getOrganization()

replaceOrganizationMetadata()

revokeOrganizationInvitation()

updateOrganizationDomain()

updateOrganizationLogo()

updateOrganizationMembershipMetadata()

updateOrganizationMembership()

updateOrganizationMetadata()

createOrganizationInvitationBulk()

createOrganization()

deleteOrganizationDomain()

getOrganizationList()

createOrganizationInvitation()

createOrganizationMembership()

deleteOrganizationLogo()

createOrganizationDomain()

updateOrganization()

getSession()

getToken()

revokeSession()

verifySession() (deprecated)

getSessionList()

getSamlConnection() (deprecated)

updateSamlConnection() (deprecated)

getSamlConnectionList() (deprecated)

createSamlConnection() (deprecated)

deleteSamlConnection() (deprecated)

createSignInToken()

revokeSignInToken()

createTestingToken()

The Backend EnterpriseConnection object

The Backend SignInToken object

The Backend Session object

Backend BillingSubscriptionItem object

Backend BillingPlan object

The Backend OauthAccessToken object

The Backend Web3Wallet object

The Backend AgentTask object

The Backend SessionActivity object

PaginatedResourceResponse

The Backend WaitlistEntry object

The Backend OAuthApplication object

Feature

The Backend SamlConnection object

The Backend Verification object

Backend Domain object

The Backend MachineScope object

The Backend User object

The Backend AllowlistIdentifier object

The Backend RedirectUrl object

Backend DeletedObject object

The Backend TestingToken object

The Backend APIKey object

Backend BillingSubscription object

The Backend Instance object

The Backend Invitation object

The Backend Client object

The Backend M2MToken object

The Backend EmailAddress object

The Backend InstanceRestrictions object

The Backend EnterpriseAccountConnection object

The Backend IdentificationLink object

The Backend EnterpriseAccount object

The Backend EnterpriseConnectionOauthConfig object

The Backend ExternalAccount object

The Backend EnterpriseConnectionSamlConnection object

The Backend OrganizationSettings object

The Backend PhoneNumber object

The Backend Organization object

The Backend OrganizationInvitation object

The Backend OrganizationMembership object

The Backend OrganizationDomain object

The Backend Machine object

Auth object

updateUser()

unbanUser()

unlockUser()

unsetPasswordCompromised()

updateUserMetadata()

updateUserProfileImage()

verifyPassword()

verifyTOTP()

banUser()

createUser()

deleteUserBackupCodes()

deleteUserExternalAccount()

deleteUserPasskey()

deleteUserProfileImage()

deleteUserTOTP()

deleteUserWeb3Wallet()

deleteUser()

getUserList()

replaceUserMetadata()

setPasswordCompromised()

getUserOauthAccessToken()

disableUserMFA()

getUser()

lockUser()

getOrganizationInvitationList()

getCount()

getOrganizationMembershipList()

Component Versioning

Component Changelog

AgentTask

Getting started with the Account Portal

Account Portal overview

Disabling the Account Portal

Linking to Account Portal pages

Clerk Billing

Seat-based Plans

Account credits

Custom Plans and prices

Default Plans

Free trials

Using Clerk with AI

Clerk Skills

Custom channel auth

API keys & M2M

Enrich instructions

Authorize tool calls

Get started with Clerk and eve

Connect MCP-compatible clients to your MCP server

Use Clerk's MCP server

Tasks after sign-up/sign-in

Sign-up and sign-in options

OAuth and OIDC overview

Verify OAuth tokens with Clerk

How Clerk implements OAuth

Use OAuth for scoped access

Use OAuth for Single Sign-On (SSO)

Base

MetaMask

OKX Wallet

Solana

Coinbase Wallet

Add Facebook as a social connection

Add GitHub as a social connection

Add GitLab as a social connection

Add Google as a social connection

Add Apple as a social connection

Add HubSpot as a social connection

Add Atlassian as a social connection

Add Hugging Face as a social connection

Account linking for OAuth

Add LINE as a social connection

Add Linear as a social connection

Add LinkedIn Open ID Connect (OIDC) as a social connection

Add Bitbucket as a social connection

Add Microsoft Azure Entra ID as a social connection

Add X/Twitter v2 as a social connection

Add Slack as a social connection

Add Xero as a social connection

Add Spotify as a social connection

Add Box as a social connection

Add Coinbase as a social connection

Add TikTok as a social connection

Add a custom OAuth provider as a social connection

Add Twitch as a social connection

Add Discord as a social connection

Add Dropbox as a social connection

Add Notion as a social connection

Add Vercel as a social connection

Twitter v1 (deprecated)

Just-in-Time (JIT) Provisioning during SAML SSO

Enterprise Single Sign-On (SSO)

Self-serve SSO

Account linking

Custom Attribute Mapping

Enterprise SSO authentication flows

Directory Sync (SCIM)

Add Okta Workforce as a SAML connection

Add a custom Identity Provider (IdP) as a SAML connection

Add Google Workspace as a SAML connection

Add Microsoft Entra ID as a SAML connection

Add a custom OpenID Connect (OIDC) Provider as an enterprise connection

Add Microsoft as an EASIE connection

Add Google as an EASIE connection

Analytics

Manage team access

Organization profile

Manage your workspace

User profile

Application Logs

Proxying the Clerk Frontend API

Authentication across different domains

Subdomain allowlist

Rate limits

Tokens and signatures

How Clerk works

Cookies

Multi-tenant architecture

Routing in Clerk

Clerk Telemetry

Vulnerability disclosure policy

Email and SMS templates

Localization prop (experimental)

Customizing Clerk

Clerk Elements (beta)

Common components

Sign-in components

Sign-up components

Build a sign-up flow with Clerk Elements

Styling for Clerk Elements

Build a sign-in flow with Clerk Elements

Sign-up

Sign-in

Primitives

shadcn/ui

User metadata

User impersonation

Invite users to your application

Users

Force a session token refresh

JWT templates

Session tokens

Manual JWT verification

Customize your session token

Sync auth status between your Chrome Extension and web app

Verify a Clerk session in Go

Bot protection

Client Trust

Securing your app

User enumeration protection

Brute force attacks and locking user accounts

Password protection and rules

Restrictions

Add reverification for sensitive actions

Rotate your Clerk API keys

Session options

Features

Authorization checks

Legal compliance

Implement basic Role Based Access Control (RBAC) with metadata

Configure Clerk Content-Security-Policy headers

CSRF protection

Fixation protection

XSS leak protection

Protect email link sign-ins and sign-ups

Unauthorized sign-in

Configure Organizations

Create and manage Organizations

Domain verification

Use Organization slugs in URLs

Organization metadata

Organizations

Organization-level Enterprise SSO

Verified Domains

Invite users to your Organization

Check Roles and Permissions with Authorization Checks

Role Sets

Roles and Permissions

Override Clerk interfaces with custom types

Instances / Environments

Making authenticated requests

Use image optimization to improve app performance

Customize your redirect URLs

Clerk environment variables

Configure a consistent CRX ID for your Chrome Extension

Add React Router to your Clerk-powered Chrome Extension

Enable offline support in your Expo app

Astro hybrid rendering

Endpoints

Enable biometric sign-in for returning users in Expo

Access the Clerk object outside of components

Verify API keys in your Next.js application with Clerk

Integrate Clerk into your Next.js + tRPC app

Install Clerk with shadcn/ui CLI

Next.js rendering modes and Clerk

Basic geo blocking

Add custom onboarding to your authentication flow

Build your own sign-in-or-up page for your Expo web app

Web support

Build your own sign-up page with prebuilt components on web

Backend-only SDK

Conventions

Frontend-only SDK

Fullstack SDK

SDK development

Philosophy

Terminology

SDK types

Migrating

Migrate from Cognito

Migrate from Firebase

Migrating from the Astro community SDK

Migrating from the Vue community SDK

Migrate from Auth.js to Clerk

Using API keys

Machine Authentication

Token formats

Using M2M tokens

Integrations

Integrate Shopify with Clerk

Integrate Clerk through the Vercel Marketplace

Integrate Encore with Clerk

Integrate Convex with Clerk

Integrate Firebase with Clerk

Integrate Grafbase with Clerk

Integrate Hasura with Clerk

Integrate InstantDB with Clerk

Integrate Neon Postgres with Clerk

Integrate Nhost with Clerk

Integrate Prisma Postgres with Clerk

Integrate Supabase with Clerk

Enable Google Analytics for Clerk

Deploy a Clerk app behind a proxy

Change domain

Deploy your Clerk app to production

Staging alternatives

Deploying a Clerk app to Vercel

Deploy a Chrome Extension to production

Deploy an Expo app to production

Deploy an Astro app to production

Build your own UI (custom flows)

Build a custom authentication flow using passkeys

Session tasks

Sign-in-or-up custom flow

Build a custom sign-out flow

Sign-up with application invitations

Build a custom sign-in flow with client trust

Build a custom email/password authentication flow

Build a custom sign-in flow with email or phone code

Build a custom flow for authenticating with enterprise connections

Build a custom forgot password flow

Build a custom flow for displaying the last authentication method

Build a custom flow for handling legal acceptance

Build a custom sign-in flow with multi-factor authentication (MFA)

Build a custom multi-session flow

Build a custom flow for authenticating with OAuth connections

Sign-up with application invitations (Legacy)

Build a custom sign-in flow with multi-factor authentication (Legacy)

Build a custom email/password authentication flow (Legacy)

Build a custom email or phone OTP authentication flow (Legacy)

Build a custom flow for authenticating with enterprise connections (Legacy)

Build a custom forgot password flow (Legacy)

Build a custom flow for displaying the last authentication method (Legacy)

Build a custom flow for handling legal acceptance (Legacy)

Build a custom flow for authenticating with OAuth connections (Legacy)

Build a custom authentication flow using passkeys (Legacy)

Sign-in-or-up custom flow (Legacy)

Build a custom flow for managing API keys

Build a custom flow for adding an email to a user's account

Build a custom flow for adding a phone number to a user's account

Build a custom flow for managing multi-factor authentication

Build a custom flow for managing SSO connections

Build a custom flow for updating a user's password

Build a custom flow for switching Organizations

Build a custom flow for updating an Organization

Handle accepting Organization invitation links

Build a custom flow for creating Organizations

Build a custom flow for managing Organization Membership Requests

Build a custom flow for creating and managing Organization invitations

Build a custom flow for managing a user's Organization invitations

Build a custom flow for managing member Roles in an Organization

Upgrade guides overview

Upgrading from v2 to v3

Versioning overview

Upgrade to API version 2025-11-10

Upgrade to API version 2026-05-12

Upgrading to Clerk Core 2

Upgrading to Clerk Core 3

Upgrade from Clerk's Node SDK to the Express SDK

Migrate from Clerk iOS SDK v0 to v1

Upgrade to @clerk/clerk-expo v2

Migrate from Clerk Android SDK v0 to v1

Upgrade to @clerk/nextjs v6

Migrate away from Middleware-based auth checks

Upgrading @clerk/clerk-expo to Core 2

Upgrading @clerk/fastify to Core 2

Upgrading @clerk/clerk-js to Core 2

Upgrading @clerk/nextjs to Core 2

Upgrading @clerk/clerk-sdk-node to Core 2

Upgrading @clerk/clerk-react to Core 2

Upgrading @clerk/remix to Core 2

Upgrading @clerk/chrome-extension to Core 2

Upgrading @clerk/backend to Core 2

Email deliverability

New domain reputation and email warm-up

Email suppression lists

Decode Clerk JWTs

Troubleshooting

Script loading

Using production keys in local development

Create a browser replay

Create a minimal reproduction

Handling webhooks with Inngest

Integrate Loops with Clerk

Webhooks overview

Sync Clerk data to your app with webhooks

Debug your webhooks

Test emails and phones

Agent Tasks

Testing

Testing with Postman or Insomnia

Test helpers

Reuse auth state across tests

Testing with Playwright

Test the sign-up form

Custom commands

Testing with Cypress

Test Account Portal flows

Backend API errors

Frontend API errors

Errors overview

Read user data

Protect content from unauthenticated users

Build a custom waitlist page

Get started with Organizations

Build your own sign-up page for your Next.js app with Clerk

Build your own sign-in-or-up page for your Next.js app with Clerk

Verify OAuth access tokens in your Next.js application with Clerk

Clerk Billing webhooks

Error handling

Build a custom flow for adding a new payment method

Build a custom checkout flow with an existing payment method

Build a custom checkout flow with a new payment method

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

AI prompts

Build an MCP server in your application with Clerk

Next.js Quickstart (App Router)

useStatements()

usePaymentElement()

useSubscription()

usePaymentMethods()

usePlans()

useUser()

useReverification()

useWaitlist()

useSessionList()

useSession()

useSignIn()

useSignUp()

Hooks Reference

useClerk()

useAPIKeys()

useAuth()

useOAuthConsent()

useOrganizationList()

useOrganization()

usePaymentAttempts()

useOrganizationCreationDefaults()

useCheckout()

useSignIn()

useSignUp()

<APIKeys /> component

<ClerkProvider>

Component Reference

<CheckoutButton /> component

<PlanDetailsButton /> component

<PricingTable />

<SubscriptionDetailsButton /> component

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

<TaskChooseOrganization /> component

<TaskResetPassword /> component

<TaskSetupMFA /> component

<Waitlist /> component

<UNSAFE_PortalProvider> component

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkDegraded>

<ClerkFailed>

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToUserProfile /> (deprecated)

<RedirectToTasks />

<Show>

APIKeys object

Billing object

SignUp object (Legacy)

SignInFuture object

SignUpFuture object

SignIn object (Legacy)

Clerk class

Client object

Organization object

Key Clerk objects

Session object

User object

CustomPage

DeletedObjectResource

SessionVerification

SignInSecondFactor

SessionTask

SignUpRedirectOptions

SignInRedirectOptions

SessionStatus

SignUpInitialValues

RoleResource

Web3Wallet

CustomMenuItem

Waitlist

RedirectOptions

VerificationResource

ClerkPaginatedResponse

UserOrganizationInvitation

TOTPResource

SSO Types

SignedInSessionResource

SignUpVerificationResource

ClerkError

BillingPlanResource

BillingPaymentMethodResource

ClerkAPIResponseError

BillingMoneyAmount

ClerkAPIError

BillingCheckoutTotals

BillingSubscriptionResource

BillingPerUnitTotalTier

BillingInitializedPaymentMethodResource

BillingCreditBalanceResource

SignInInitialValues

BillingCreditLedgerResource

APIKeyResource

SignInFirstFactor

BillingSubscriptionItemSeats

BackupCodeResource

SetActiveParams

BillingSubscriptionItemResource

BillingCheckoutResource

SessionWithActivities

BillingStatementResource

OrganizationCreationDefaults

PublicUserData

OrganizationMembership

OrganizationMembershipRequest

BillingStatementTotals

ProtectCheckResource

OrganizationInvitation

BillingStatementGroup

PhoneNumber

OrganizationDomainsBulkOwnershipVerificationResource

BillingPerUnitTotal

BillingPaymentResource

OAuthConsentScope

BillingPlanUnitPrice

OrganizationDomainResource

OrganizationCustomRoleKey

OrganizationCustomPermissionKey

PermissionResource

OAuthConsentInfo

BillingPlanPrice

OAuthApplication

PasskeyResource

BillingPayerResource

Metadata

Clerk types

OrganizationSuggestion

LastAuthenticationStrategy

BillingPlanUnitPriceTier

IdentificationLinkResource

Errors

ImageResource

EnterpriseAccount

HandleOAuthCallbackParams

FeatureResource

EnterpriseAccountConnection

ExternalAccount

EmailLinkError

EmailAddress

Use Clerk with Next.js 12 and older

@clerk/eslint-plugin

clerkMiddleware()

Clerk Next.js SDK

buildClerkProps

getAuth()

auth()

currentUser()

Route Handlers

Server Actions

Clerk: auth() was called but Clerk can't detect usage of clerkMiddleware()

React Quickstart

Read user data

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <OrganizationProfile /> component

Add custom pages and links to the <UserProfile /> component

Build a custom waitlist page

Get started with Organizations

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2C SaaS

Clerk Billing for B2B SaaS

AI prompts

Build your own sign-in-or-up page for your React app with Clerk

Build your own sign-up page for your React app with Clerk

Add React Router to your Clerk + React application

Clerk Billing webhooks

Error handling

Build a custom flow for handling user impersonation

Build a custom flow for adding a new payment method

Build a custom checkout flow with an existing payment method

Build a custom checkout flow with a new payment method

Build a custom waitlist form

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

APIKeys object

Billing object

Clerk class

Client object

Organization object

Key Clerk objects

Session object

SignInFuture object

SignIn object (Legacy)

SignUpFuture object

SignUp object (Legacy)

User object

useAPIKeys()

Hooks Reference

useAuth()

useCheckout()

useClerk()

useOAuthConsent()

useOrganizationCreationDefaults()

useOrganizationList()

useOrganization()

usePaymentAttempts()

usePaymentElement()

usePaymentMethods()

usePlans()

useReverification()

useSessionList()

useSession()

useSignIn()

useSignUp()

useStatements()

useUser()

useSubscription()

useWaitlist()

useSignIn()

useSignUp()

OrganizationCustomPermissionKey

OAuthApplication

OrganizationCustomRoleKey

OrganizationDomainResource

OAuthConsentInfo

OrganizationDomainsBulkOwnershipVerificationResource

OrganizationInvitation

OrganizationMembershipRequest

OAuthConsentScope

OrganizationMembership

Clerk types

OrganizationSuggestion

PasskeyResource

PermissionResource

PhoneNumber

ProtectCheckResource

PublicUserData

BillingPlanUnitPrice

CustomPage

ExternalAccount

RedirectOptions

FeatureResource

RoleResource

BillingStatementGroup

BillingSubscriptionResource

SessionStatus

DeletedObjectResource

ClerkAPIError

HandleOAuthCallbackParams

SessionTask

BillingStatementResource

SessionVerification

EmailAddress

ClerkAPIResponseError

SessionWithActivities

IdentificationLinkResource

SetActiveParams

SignInFirstFactor

SignInInitialValues

SignInRedirectOptions

BillingMoneyAmount

BillingStatementTotals

ImageResource

SignInSecondFactor

ClerkError

BillingPayerResource

BillingSubscriptionItemResource

SignUpInitialValues

LastAuthenticationStrategy

BillingPaymentMethodResource

ClerkPaginatedResponse

SignUpRedirectOptions

BillingPaymentResource

BillingSubscriptionItemSeats

Metadata

CustomMenuItem

SignUpVerificationResource

BillingPlanPrice

SignedInSessionResource

BillingPerUnitTotal

BillingPlanResource

SSO Types

BillingPerUnitTotalTier

BillingPlanUnitPriceTier

TOTPResource

UserOrganizationInvitation

BillingInitializedPaymentMethodResource

VerificationResource

Waitlist

Web3Wallet

EmailLinkError

EnterpriseAccountConnection

OrganizationCreationDefaults

Errors

EnterpriseAccount

APIKeyResource

BackupCodeResource

BillingCheckoutResource

BillingCheckoutTotals

BillingCreditBalanceResource

BillingCreditLedgerResource

<APIKeys /> component

<ClerkProvider>

Component Reference

<CheckoutButton /> component

<PlanDetailsButton /> component

<PricingTable />

<SubscriptionDetailsButton /> component

<UNSAFE_PortalProvider> component

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<CreateOrganization /> component

<OrganizationList /> component

<TaskResetPassword /> component

<Waitlist /> component

<TaskSetupMFA /> component

<GoogleOneTap /> component

<SignUp /> component

<TaskChooseOrganization /> component

<OAuthConsent /> component

<SignIn /> component

<ClerkDegraded>

<AuthenticateWithRedirectCallback />

<Show>

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<RedirectToUserProfile /> (deprecated)

<ClerkFailed>

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

Clerk React SDK

JavaScript Quickstart

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Variables prop

Appearance prop

Options prop

Themes

captcha prop

Bring your own CSS

<APIKeys /> component

Component Reference

<UserAvatar /> component

<UserProfile /> component

<UserButton /> component

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkLoaded>

<PricingTable />

<Waitlist /> component

<TaskChooseOrganization /> component

<TaskResetPassword /> component

<TaskSetupMFA /> component

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

Billing object

Clerk class

Client object

Organization object

SignInFuture object

SignIn object (Legacy)

Key Clerk objects

SignUpFuture object

Session object

SignUp object (Legacy)

User object

APIKeys object

OrganizationSuggestion

BillingStatementResource

OrganizationMembershipRequest

BillingStatementTotals

OrganizationMembership

OrganizationDomainsBulkOwnershipVerificationResource

BillingSubscriptionItemResource

OrganizationInvitation

BillingSubscriptionItemSeats

OrganizationDomainResource

BillingMoneyAmount

BillingSubscriptionResource

OrganizationCustomPermissionKey

ClerkAPIError

OrganizationCustomRoleKey

OrganizationCreationDefaults

OAuthConsentInfo

BillingPayerResource

OAuthConsentScope

SessionTask

OAuthApplication

BillingPaymentMethodResource

ImageResource

LastAuthenticationStrategy

SessionStatus

Metadata

BillingPaymentResource

IdentificationLinkResource

CustomPage

DeletedObjectResource

RoleResource

Errors

EmailAddress

BillingPerUnitTotalTier

ExternalAccount

RedirectOptions

EmailLinkError

BillingPerUnitTotal

EnterpriseAccountConnection

ClerkAPIResponseError

ClerkError

BillingPlanUnitPriceTier

ProtectCheckResource

BillingPlanPrice

PublicUserData

BillingPlanResource

PhoneNumber

PermissionResource

EnterpriseAccount

FeatureResource

PasskeyResource

HandleOAuthCallbackParams

ClerkPaginatedResponse

BillingPlanUnitPrice

CustomMenuItem

BillingStatementGroup

Clerk types

Web3Wallet

Waitlist

VerificationResource

SignInInitialValues

UserOrganizationInvitation

BillingCheckoutResource

TOTPResource

SignInRedirectOptions

SSO Types

BillingCheckoutTotals

SignUpVerificationResource

SignInFirstFactor

SignedInSessionResource

BillingCreditBalanceResource

SignUpInitialValues

SessionWithActivities

SignUpRedirectOptions

BillingCreditLedgerResource

APIKeyResource

SetActiveParams

SignInSecondFactor

BillingInitializedPaymentMethodResource

BackupCodeResource

SessionVerification

Clerk JavaScript SDK

Chrome Extension Quickstart (Plasmo)

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Error handling

Build a custom flow for handling user impersonation

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Embeddable email links with sign-in tokens

Build a custom flow for handling email links

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

<APIKeys /> component

<ClerkProvider>

Component Reference

<SignIn /> component

<SignUp /> component

<Waitlist /> component

<PricingTable />

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<Show>

<AuthenticateWithRedirectCallback />

<ClerkDegraded>

<ClerkLoaded>

<ClerkLoading>

<ClerkFailed>

<SignOutButton>

<SignInButton>

<SignUpButton>

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

Hooks Reference

useSessionList()

useReverification()

useOrganization()

useAuth()

useClerk()

useOrganizationList()

useOrganizationCreationDefaults()

useSession()

useSignIn()

useSignUp()

useUser()

useWaitlist()

useSignUp()

useSignIn()

Key Clerk objects

Session object

SignInFuture object

SignIn object (Legacy)

SignUpFuture object

SignUp object (Legacy)

User object

Organization object

APIKeys object

Billing object

Clerk class

Client object

BillingPlanResource

SignUpInitialValues

BillingPlanUnitPriceTier

SignUpRedirectOptions

SignUpVerificationResource

BillingPlanUnitPrice

SignedInSessionResource

BillingStatementGroup

SSO Types

BillingStatementResource

BillingStatementTotals

PublicUserData

LastAuthenticationStrategy

SignInSecondFactor

TOTPResource

BillingPlanPrice

UserOrganizationInvitation

OrganizationMembership

RedirectOptions

OrganizationCustomPermissionKey

BillingSubscriptionItemResource

BillingPerUnitTotal

OrganizationSuggestion

BillingSubscriptionItemSeats

OrganizationCustomRoleKey

RoleResource

VerificationResource

Metadata

SignInRedirectOptions

Waitlist

BillingCheckoutResource

DeletedObjectResource

BillingSubscriptionResource

EmailAddress

OAuthApplication

Web3Wallet

OrganizationDomainResource

ClerkAPIError

EmailLinkError

OAuthConsentInfo

ClerkAPIResponseError

EnterpriseAccountConnection

OrganizationDomainsBulkOwnershipVerificationResource

OAuthConsentScope

OrganizationInvitation

EnterpriseAccount

OrganizationCreationDefaults

FeatureResource

OrganizationMembershipRequest

ExternalAccount

HandleOAuthCallbackParams

Errors

IdentificationLinkResource

Clerk types

ClerkError

ImageResource

ClerkPaginatedResponse

BackupCodeResource

CustomMenuItem

APIKeyResource

CustomPage

SessionStatus

PasskeyResource

PermissionResource

PhoneNumber

ProtectCheckResource

SessionWithActivities

BillingPayerResource

BillingCheckoutTotals

BillingCreditBalanceResource

BillingCreditLedgerResource

BillingInitializedPaymentMethodResource

BillingPaymentMethodResource

BillingPaymentResource

SessionTask

SetActiveParams

SignInFirstFactor

BillingPerUnitTotalTier

BillingMoneyAmount

SignInInitialValues

SessionVerification

Clerk Chrome Extension SDK

createClerkClient()

Read user data

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling user impersonation

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Sign in with Apple

Sign in with Google

Social connections (OAuth)

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Expo Quickstart

<ClerkProvider>

Component Reference

<PricingTable />

<GoogleOneTap /> component

<SignIn /> component

<SignUp /> component

<Waitlist /> component

<UNSAFE_PortalProvider> component

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<ClerkLoaded>

<ClerkLoading>

<Show>

useOrganization()

useSessionList()

useOrganizationList()

useAuth()

Hooks Reference

useClerk()

useOrganizationCreationDefaults()

useWaitlist()

useUser()

useSignIn()

useSignUp()

useSession()

useSignIn()

useSignUp()

Client object

Organization object

Clerk class

Key Clerk objects

SignIn object (Legacy)

APIKeys object

Session object

Billing object

User object

SignInFuture object

SignUp object (Legacy)

SignUpFuture object

Waitlist

Web3Wallet

VerificationResource

SessionWithActivities

SetActiveParams

SignInFirstFactor

ExternalAccount

SignInInitialValues

BillingPlanPrice

SignInRedirectOptions

SignInSecondFactor

BillingStatementResource

SignUpInitialValues

BillingPlanResource

OrganizationDomainsBulkOwnershipVerificationResource

SessionTask

BillingPlanUnitPriceTier

SignUpRedirectOptions

SessionStatus

BillingPlanUnitPrice

OrganizationSuggestion

ClerkPaginatedResponse

RoleResource

OrganizationInvitation

BillingStatementGroup

BillingCreditBalanceResource

SignUpVerificationResource

OrganizationMembership

RedirectOptions

BillingInitializedPaymentMethodResource

OrganizationMembershipRequest

OAuthApplication

BillingStatementTotals

SignedInSessionResource

OAuthConsentScope

BillingCreditLedgerResource

CustomMenuItem

BillingSubscriptionItemResource

PublicUserData

ClerkAPIError

SSO Types

IdentificationLinkResource

HandleOAuthCallbackParams

ClerkAPIResponseError

OAuthConsentInfo

BillingSubscriptionItemSeats

Metadata

ImageResource

TOTPResource

BillingSubscriptionResource

ClerkError

BillingCheckoutTotals

CustomPage

BillingPaymentMethodResource

LastAuthenticationStrategy

ProtectCheckResource

FeatureResource

UserOrganizationInvitation

OrganizationCreationDefaults

DeletedObjectResource

EnterpriseAccountConnection

PhoneNumber

BillingMoneyAmount

SessionVerification

OrganizationCustomPermissionKey

EmailAddress

BillingPayerResource

BillingPaymentResource

EmailLinkError

PermissionResource

EnterpriseAccount

OrganizationCustomRoleKey

BillingPerUnitTotalTier

PasskeyResource

Errors

OrganizationDomainResource

Clerk types

BillingPerUnitTotal

BackupCodeResource

APIKeyResource

BillingCheckoutResource

Configure passkeys for Expo

Clerk Expo SDK

useSignInWithApple()

useSignInWithGoogle()

useSSO()

useOAuth() (deprecated)

useLocalCredentials()

<AuthView /> component

Expo Native Components (beta)

Theming Expo native components

<UserButton />

<UserProfileView /> component

Error handling

Build a custom flow for handling user impersonation

ClerkTheme

Sign in with Google

Social connections (OAuth)

Android Quickstart

Authentication flows

Clerk

Configure the SDK

Install the SDK

Organization management

Welcome

User management

Integrate Convex with Clerk

View Reference

OrganizationListView

OrganizationProfileView

OrganizationSwitcher

AuthView

UserProfileView

UserButton

Configure passkeys for Android

View Reference

UserButton

UserProfileView

OrganizationListView

OrganizationProfileView

OrganizationSwitcher

AuthView

Clerk

Configure the SDK

Install the SDK

Organization management

Welcome

User management

Authentication flows

Integrate Convex with Clerk

Error handling

ClerkTheme

Sign in with Apple

Social connections (OAuth)

iOS Quickstart

SwiftUI previews

Watch Connectivity

Component Reference

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Social connections (OAuth)

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Build an MCP server in your application with Clerk

Express Quickstart

clerkMiddleware()

getAuth()

Clerk Express SDK

requireAuth() (deprecated)

Fastify Quickstart

Component Reference

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Social connections (OAuth)

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

clerkPlugin()

getAuth()

Clerk Fastify SDK

Read user data

Build a custom waitlist page

Get started with Organizations

Build your own sign-in-or-up page for your React Router app with Clerk

Build your own sign-up page for your React Router app with Clerk

Add React Router to your Clerk + React application

Verify OAuth access tokens in your React Router application with Clerk

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

React Router Quickstart

Hooks Reference

useAuth()

useClerk()

useOAuthConsent()

useOrganizationCreationDefaults()

useOrganizationList()

useOrganization()

useReverification()

useSessionList()

useSession()

useSignIn()

useSignUp()

useUser()

useWaitlist()

useSignIn()

useSignUp()

<APIKeys /> component

<ClerkProvider>

Component Reference

<UNSAFE_PortalProvider> component

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkDegraded>

<ClerkFailed>

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<RedirectToUserProfile /> (deprecated)

<Show>

<PricingTable />

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

<TaskChooseOrganization /> component

<TaskResetPassword /> component

<TaskSetupMFA /> component

<Waitlist /> component

Key Clerk objects

SignIn object (Legacy)

Organization object

SignUpFuture object

SignUp object (Legacy)

User object

Session object

SignInFuture object

APIKeys object

Billing object

Clerk class

Client object

SignUpVerificationResource

SignedInSessionResource

SSO Types

SignUpRedirectOptions

OAuthApplication

OAuthConsentInfo

OAuthConsentScope

OrganizationCreationDefaults

OrganizationCustomPermissionKey

OrganizationCustomRoleKey

OrganizationDomainResource

OrganizationDomainsBulkOwnershipVerificationResource

OrganizationInvitation

OrganizationMembershipRequest

OrganizationMembership

OrganizationSuggestion

Clerk types

PasskeyResource

PermissionResource

TOTPResource

PhoneNumber

VerificationResource

UserOrganizationInvitation

ProtectCheckResource

PublicUserData

RedirectOptions

RoleResource

SessionStatus

SessionTask

SessionVerification

SessionWithActivities

SetActiveParams

SignInFirstFactor

SignInInitialValues

SignInRedirectOptions

SignInSecondFactor

SignUpInitialValues

Waitlist

Web3Wallet

BillingPlanUnitPriceTier

BackupCodeResource

BillingPlanUnitPrice

BillingCheckoutResource

BillingCheckoutTotals

DeletedObjectResource

BillingCreditBalanceResource

BillingStatementGroup

BillingCreditLedgerResource

EmailAddress

BillingInitializedPaymentMethodResource

BillingStatementResource

BillingMoneyAmount

BillingStatementTotals

BillingPayerResource

EmailLinkError

BillingPaymentMethodResource

BillingSubscriptionItemResource

BillingPaymentResource

BillingSubscriptionItemSeats

EnterpriseAccountConnection

BillingSubscriptionResource

BillingPerUnitTotalTier

EnterpriseAccount

ClerkAPIError

BillingPerUnitTotal

Errors

ClerkAPIResponseError

APIKeyResource

BillingPlanPrice

ClerkError

ExternalAccount

ClerkPaginatedResponse

FeatureResource

BillingPlanResource

CustomMenuItem

CustomPage

HandleOAuthCallbackParams

IdentificationLinkResource

ImageResource

LastAuthenticationStrategy

Metadata

clerkMiddleware() | React Router

getAuth()

Clerk React Router SDK

rootAuthLoader()

TanStack React Start Quickstart

BillingStatementGroup

BillingStatementResource

BillingStatementTotals

BillingSubscriptionItemResource

BillingSubscriptionItemSeats

BillingSubscriptionResource

ClerkAPIError

ClerkAPIResponseError

ClerkError

ClerkPaginatedResponse

CustomMenuItem

CustomPage

DeletedObjectResource

EmailAddress

EmailLinkError

EnterpriseAccountConnection

EnterpriseAccount

Errors

ExternalAccount

FeatureResource

HandleOAuthCallbackParams

ImageResource

IdentificationLinkResource

LastAuthenticationStrategy

Metadata

OAuthApplication

OAuthConsentInfo

OAuthConsentScope

OrganizationCreationDefaults

OrganizationCustomPermissionKey

OrganizationCustomRoleKey

OrganizationDomainResource

OrganizationDomainsBulkOwnershipVerificationResource

OrganizationInvitation

OrganizationMembershipRequest

OrganizationMembership

OrganizationSuggestion

Clerk types

PasskeyResource

PermissionResource

PhoneNumber

ProtectCheckResource

PublicUserData

RedirectOptions

RoleResource

SessionStatus

SessionTask

SessionVerification

SessionWithActivities

APIKeyResource

SetActiveParams

SignInFirstFactor

BackupCodeResource

SignInInitialValues

SignInRedirectOptions

BillingCheckoutResource

SignInSecondFactor

BillingCheckoutTotals

SignUpInitialValues

SignUpRedirectOptions

BillingCreditBalanceResource

BillingCreditLedgerResource

SignUpVerificationResource

BillingInitializedPaymentMethodResource

BillingMoneyAmount

BillingPayerResource

BillingPaymentMethodResource

UserOrganizationInvitation

BillingPaymentResource

VerificationResource

SignedInSessionResource

BillingPerUnitTotalTier

SSO Types

BillingPerUnitTotal

TOTPResource

Waitlist

Web3Wallet

BillingPlanPrice

BillingPlanResource

BillingPlanUnitPriceTier

BillingPlanUnitPrice

User object

SignUpFuture object

SignUp object (Legacy)

APIKeys object

Billing object

Clerk class

Client object

Organization object

Key Clerk objects

Session object

SignInFuture object

SignIn object (Legacy)

Hooks Reference

useAuth()

useClerk()

useOAuthConsent()

useOrganizationCreationDefaults()

useOrganizationList()

useOrganization()

useReverification()

useSessionList()

useSignIn()

useSession()

useUser()

useSignUp()

useWaitlist()

useSignIn()

useSignUp()

<APIKeys /> component

<ClerkProvider>

Component Reference

<UNSAFE_PortalProvider> component

<UserProfile /> component

<UserAvatar /> component

<UserButton /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkDegraded>

<ClerkFailed>

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<RedirectToUserProfile /> (deprecated)

<Show>

<PricingTable />

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

<TaskChooseOrganization /> component

<TaskResetPassword /> component

<TaskSetupMFA /> component

<Waitlist /> component

<GoogleOneTap /> component

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <OrganizationProfile /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Read user data

Build a custom waitlist page

Get started with Organizations

Build your own sign-in-or-up page for your TanStack React Start app with Clerk

Build your own sign-up page for your TanStack React Start app with Clerk

Verify OAuth access tokens in your TanStack React Start application with Clerk

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling email links (Legacy)

Build a custom flow for handling user impersonation

auth()

clerkMiddleware()

Clerk TanStack React Start SDK

Component Reference

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling email links (Legacy)

Build a custom flow for handling user impersonation

Appearance prop

Bring your own CSS

Themes

captcha prop

Options prop

Variables prop

Social connections (OAuth)

Clerk Go SDK

Clerk Go SDK

User object

Key Clerk objects

Session object

SignInFuture object

SignUpFuture object

Organization object

APIKeys object

Billing object

Clerk class

Client object

Hooks Reference

useAuth()

<APIKeys /> component

Component Reference

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationSwitcher /> component

<OrganizationProfile /> component

<AuthenticateWithRedirectCallback />

<ClerkLoaded>

<ClerkLoading>

<Show>

<PricingTable />

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

<Waitlist /> component

OrganizationCustomPermissionKey

SetActiveParams

SignInFirstFactor

SignInInitialValues

ClerkAPIResponseError

ClerkError

ClerkPaginatedResponse

CustomMenuItem

CustomPage

DeletedObjectResource

EmailAddress

EmailLinkError

EnterpriseAccountConnection

SignInRedirectOptions

SignInSecondFactor

SignUpInitialValues

SignUpRedirectOptions

SignUpVerificationResource

SignedInSessionResource

SSO Types

TOTPResource

UserOrganizationInvitation

VerificationResource

Waitlist

Web3Wallet

SessionWithActivities

SessionVerification

Clerk types

PasskeyResource

ClerkAPIError

OrganizationCustomRoleKey

PermissionResource

OrganizationDomainResource

PhoneNumber

OrganizationDomainsBulkOwnershipVerificationResource

ProtectCheckResource

EnterpriseAccount

PublicUserData

OrganizationInvitation

Errors

RedirectOptions

OrganizationMembershipRequest

RoleResource

OrganizationMembership

SessionStatus

ExternalAccount

OrganizationSuggestion

SessionTask

FeatureResource

OAuthConsentInfo

OAuthConsentScope

HandleOAuthCallbackParams

OrganizationCreationDefaults

IdentificationLinkResource

ImageResource

Metadata

OAuthApplication

LastAuthenticationStrategy

BillingCheckoutTotals

BillingCreditBalanceResource

APIKeyResource

BillingCheckoutResource

BillingCreditLedgerResource

BackupCodeResource

BillingInitializedPaymentMethodResource

BillingPlanResource

BillingPlanUnitPriceTier

BillingMoneyAmount

BillingStatementTotals

BillingPayerResource

BillingSubscriptionResource

BillingSubscriptionItemSeats

BillingPlanUnitPrice

BillingStatementGroup

BillingPaymentMethodResource

BillingStatementResource

BillingSubscriptionItemResource

BillingPaymentResource

BillingPerUnitTotalTier

BillingPerUnitTotal

BillingPlanPrice

Read user data

Get started with Organizations

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling email links (Legacy)

Build a custom flow for handling user impersonation

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

AI prompts

Astro Quickstart

Clerk Astro SDK

Use Clerk with Astro and React

Locals

updateClerkOptions()

Integration

clerkMiddleware() | Astro

$signUpStore

$userStore

$authStore

$clerkStore

$organizationStore

$sessionListStore

$sessionStore

$signInStore

Nuxt Quickstart

Read user data

Protect content from unauthenticated users

Build a custom waitlist page

Get started with Organizations

Build your own sign-up page for your Nuxt app with Clerk

Build your own sign-in-or-up page for your Nuxt app with Clerk

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Options prop

Appearance prop

Themes

Variables prop

Bring your own CSS

captcha prop

Add custom pages and links to the <OrganizationProfile /> component

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

APIKeys object

Billing object

Clerk class

Client object

Organization object

Key Clerk objects

Session object

SignInFuture object

SignUpFuture object

User object

useClerk() | Vue

useAuth() | Vue

useOrganization() | Vue

useSessionList() | Vue

useSession() | Vue

useSignIn() | Vue

useSignUp() | Vue

useUser() | Vue

<APIKeys /> component

Component Reference

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<RedirectToUserProfile /> (deprecated)

<Show>

<PricingTable />

<Waitlist /> component

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

PasskeyResource

PermissionResource

PhoneNumber

ProtectCheckResource

Clerk types

PublicUserData

RedirectOptions

RoleResource

APIKeyResource

VerificationResource

BackupCodeResource

SessionStatus

BillingCheckoutResource

BillingCheckoutTotals

BillingCreditBalanceResource

BillingCreditLedgerResource

SessionTask

BillingInitializedPaymentMethodResource

BillingMoneyAmount

BillingPayerResource

SessionVerification

BillingPaymentMethodResource

SessionWithActivities

SetActiveParams

SignInFirstFactor

SignInInitialValues

SignInRedirectOptions

SignInSecondFactor

SignUpInitialValues

SignUpRedirectOptions

SignUpVerificationResource

SignedInSessionResource

SSO Types

TOTPResource

UserOrganizationInvitation

Waitlist

Web3Wallet

CustomPage

DeletedObjectResource

EmailAddress

EmailLinkError

EnterpriseAccountConnection

EnterpriseAccount

Errors

ExternalAccount

FeatureResource

BillingPaymentResource

HandleOAuthCallbackParams

BillingPerUnitTotalTier

OrganizationCustomPermissionKey

BillingPerUnitTotal

IdentificationLinkResource

OrganizationCustomRoleKey

ImageResource

LastAuthenticationStrategy

Metadata

BillingPlanPrice

BillingPlanResource

OAuthApplication

BillingPlanUnitPriceTier

OrganizationDomainResource

BillingPlanUnitPrice

OAuthConsentInfo

BillingStatementGroup

BillingStatementResource

OrganizationDomainsBulkOwnershipVerificationResource

BillingStatementTotals

OAuthConsentScope

OrganizationInvitation

BillingSubscriptionItemResource

BillingSubscriptionItemSeats

OrganizationCreationDefaults

BillingSubscriptionResource

OrganizationMembershipRequest

ClerkAPIError

ClerkAPIResponseError

ClerkError

OrganizationMembership

ClerkPaginatedResponse

OrganizationSuggestion

CustomMenuItem

clerkMiddleware() | Nuxt

@clerk/nuxt module

Clerk Nuxt SDK

Vue Quickstart

Bring your own CSS

captcha prop

Options prop

Appearance prop

Themes

Variables prop

Add custom items and links to the <UserButton /> component

Add custom pages and links to the <OrganizationProfile /> component

Add custom pages and links to the <UserProfile /> component

Social connections (OAuth)

Set up a custom OAuth consent page

Clerk Billing for B2B SaaS

Clerk Billing for B2C SaaS

Clerk Billing webhooks

Error handling

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Build a custom flow for handling user impersonation

Client object

Clerk class

Organization object

Key Clerk objects

Session object

SignInFuture object

SignUpFuture object

User object

APIKeys object

Billing object

useAuth() | Vue

useClerk() | Vue

useOrganization() | Vue

useSessionList() | Vue

useSession() | Vue

useSignIn() | Vue

useSignUp() | Vue

useUser() | Vue

<APIKeys /> component

Component Reference

<UNSAFE_PortalProvider> component

<UserAvatar /> component

<UserButton /> component

<UserProfile /> component

<SignInButton>

<SignInWithMetamaskButton>

<SignOutButton>

<SignUpButton>

<CreateOrganization /> component

<OrganizationList /> component

<OrganizationProfile /> component

<OrganizationSwitcher /> component

<AuthenticateWithRedirectCallback />

<ClerkLoaded>

<ClerkLoading>

<RedirectToCreateOrganization /> (deprecated)

<RedirectToOrganizationProfile /> (deprecated)

<RedirectToSignIn />

<RedirectToSignUp />

<RedirectToTasks />

<RedirectToUserProfile /> (deprecated)

<Show>

<SubscriptionDetailsButton /> component

<PricingTable />

<CheckoutButton /> component

<PlanDetailsButton /> component

<GoogleOneTap /> component

<OAuthConsent /> component

<SignIn /> component

<SignUp /> component

<Waitlist /> component

SignInRedirectOptions

SignInInitialValues

SignInFirstFactor

SessionVerification

SessionWithActivities

SetActiveParams

SessionTask

PhoneNumber

ProtectCheckResource

PublicUserData

RedirectOptions

RoleResource

SessionStatus

PermissionResource

PasskeyResource

Clerk types

APIKeyResource

OrganizationMembership

BackupCodeResource

TOTPResource

UserOrganizationInvitation

OrganizationSuggestion

VerificationResource

Waitlist

Web3Wallet

BillingCheckoutResource

OrganizationMembershipRequest

BillingCheckoutTotals

OrganizationCustomRoleKey

BillingCreditBalanceResource

OrganizationDomainResource

BillingCreditLedgerResource

OrganizationDomainsBulkOwnershipVerificationResource

BillingInitializedPaymentMethodResource

OrganizationInvitation

BillingMoneyAmount

OrganizationCustomPermissionKey

BillingPayerResource

LastAuthenticationStrategy

BillingPaymentMethodResource

Metadata

BillingPaymentResource

OAuthApplication

BillingPerUnitTotalTier

OAuthConsentInfo

BillingPerUnitTotal

OAuthConsentScope

BillingPlanPrice

OrganizationCreationDefaults

BillingPlanResource

ImageResource

BillingPlanUnitPriceTier

CustomMenuItem

BillingPlanUnitPrice

CustomPage

BillingStatementGroup

DeletedObjectResource

SignUpRedirectOptions

EmailAddress

SignedInSessionResource

SignUpInitialValues

SignInSecondFactor

SignUpVerificationResource

BillingStatementResource

EmailLinkError

EnterpriseAccountConnection

EnterpriseAccount

Errors

ExternalAccount

FeatureResource

HandleOAuthCallbackParams

IdentificationLinkResource

BillingSubscriptionItemSeats

BillingSubscriptionResource

ClerkAPIError

ClerkAPIResponseError

SSO Types

ClerkError

ClerkPaginatedResponse

BillingStatementTotals

BillingSubscriptionItemResource

updateClerkOptions()

Clerk Vue SDK

clerkPlugin

Component Reference

Ruby Quickstart

Options prop

Bring your own CSS

Appearance prop

Themes

captcha prop

Variables prop

Social connections (OAuth)

Error handling

Build a custom flow for handling user impersonation

Add bot protection to your custom sign-up flow

Build a custom flow for handling email links

Embeddable email links with sign-in tokens

Build a custom Google One Tap authentication flow

Build a custom waitlist form

Build a custom flow for handling email links (Legacy)

Embeddable email links with sign-in tokens (Legacy)

Clerk Ruby SDK

Ruby with Rack

Ruby on Rails integration

Sinatra integration

Upgrade to clerk-sdk-ruby v4

Upgrade to clerk-sdk-ruby v5

## What is Clerk's llms.txt?

Clerk publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what Clerk offers and where to find details.

Issues

Spec

1

Sections

2326

Links

473.3 KB

Size

~121.2k

Tokens

Sections: Docs

## Add Clerk Docs to Your AI Assistant

Select your tool to see how to add Clerk's llms.txt as a documentation source.

Cursor

 Windsurf

 Claude Code

 ChatGPT

 Zed

 Copilot

1. 1

   Open any chat or composer panel
2. 2

   Type @Docs and select "Add new doc"
3. 3

   Paste the URL: https://clerk.com/llms.txt
4. 4

   Wait for the green dot (indexing complete)
5. 5

   Reference @Docs in chat when asking about Clerk

Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too.

## Spec Compliance 16 errors

## Frequently Asked Questions

Where is Clerk's llms.txt file?

Clerk publishes its llms.txt at https://clerk.com/llms.txt. This file provides a structured, markdown-formatted index of Clerk's documentation that AI systems can consume to understand the project's APIs, guides, and references.

How do I use Clerk's llms.txt with AI coding assistants?

Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of Clerk's documentation so it can provide better code suggestions and answers about Clerk.

What does Clerk's llms.txt contain?

Clerk's llms.txt contains 1 sections and 2326 documentation links in 473.3 KB (~121.2k tokens). Key sections include Docs.

How many tokens does Clerk's llms.txt use?

The concise llms.txt index is approximately 121.2k tokens (473.3 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline.

What is Clerk?

Authentication and user management for developers. Clerk's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with Clerk.

Can I generate an llms.txt for my own project?

Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator.

## Browse More llms.txt Files

[Medusa Digital commerce platform with a built-in framework](https://mdream.dev/llms-txt/clerk/llms-txt/medusa) [Mintlify Beautiful documentation that converts users](https://mdream.dev/llms-txt/clerk/llms-txt/mintlify) [Vendure Documentation Vendure is a headless commerce framework built on Node.js with TypeScript.](https://mdream.dev/llms-txt/clerk/llms-txt/vendure-documentation) [GitHub Docs GitHub documentation](https://mdream.dev/llms-txt/clerk/llms-txt/github-docs) [React Native · Learn once, write anywhere A framework for building native apps for Android, iOS, and more using React](https://mdream.dev/llms-txt/clerk/llms-txt/react-native-learn-once-write-anywhere) [UnoCSS Instant on-demand atomic CSS engine](https://mdream.dev/llms-txt/clerk/llms-txt/unocss) [fast-check Documentation Complete documentation for fast-check - Property-based testing framework for JavaScript/TypeScript](https://mdream.dev/llms-txt/clerk/llms-txt/fast-check-documentation) [Bun Incredibly fast JavaScript runtime, bundler, and package manager](https://mdream.dev/llms-txt/clerk/llms-txt/bun)

[View all 99 projects ](https://mdream.dev/llms-txt/clerk/llms-txt)

## Related Tools

[<h3>llms.txt Generator</h3>Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/clerk/tools/llms-txt/generator) [<h3>llms.txt Validator</h3>Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/clerk/tools/llms-txt/validator)

© 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license)

[GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)