# Clerk

## Docs

- [Clerk CLI]({{SITE_URL}}/docs/cli): Learn how to use the Clerk CLI to set up authentication, manage configuration, and integrate with AI agents.
- [Welcome to Clerk Docs]({{SITE_URL}}/docs/): Add complete user management to your application in minutes.
- [Pin a Clerk SDK]({{SITE_URL}}/docs/pinning): Learn how to pin a Clerk SDK to a specific version.
- [Maintenance Mode]({{SITE_URL}}/docs/maintenance-mode): Learn about Clerk's Maintenance Mode.
- [Ruby Quickstart]({{SITE_URL}}/docs/ruby/getting-started/quickstart): Learn how to use Clerk to quickly and easily add secure authentication and user management to your Ruby application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/ruby/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Bring your own CSS]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`captcha` prop]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [`Variables` prop]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`Appearance` prop]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [Themes]({{SITE_URL}}/docs/ruby/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Error handling]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom waitlist form]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/ruby/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Component Reference]({{SITE_URL}}/docs/ruby/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [Vue Quickstart]({{SITE_URL}}/docs/vue/getting-started/quickstart): Add authentication and user management to your Vue app with Clerk.
- [Social connections (OAuth)]({{SITE_URL}}/docs/vue/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/vue/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/vue/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/vue/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/vue/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/vue/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Bring your own CSS]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Variables` prop]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`Options` prop]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Appearance` prop]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [Themes]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`captcha` prop]({{SITE_URL}}/docs/vue/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/vue/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Error handling]({{SITE_URL}}/docs/vue/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/vue/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom waitlist form]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/vue/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/vue/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [`<APIKeys />` component]({{SITE_URL}}/docs/vue/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [Component Reference]({{SITE_URL}}/docs/vue/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/vue/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<SignIn />` component]({{SITE_URL}}/docs/vue/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<SignUp />` component]({{SITE_URL}}/docs/vue/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<Waitlist />` component]({{SITE_URL}}/docs/vue/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<CheckoutButton />` component]({{SITE_URL}}/docs/vue/reference/components/billing/checkout-button): Clerk's <CheckoutButton /> component renders a button that opens the checkout drawer for Subscription Plans.
- [`<PlanDetailsButton />` component]({{SITE_URL}}/docs/vue/reference/components/billing/plan-details-button): Clerk's <PlanDetailsButton /> component renders a button that opens the Plan details drawer.
- [`<SubscriptionDetailsButton />` component]({{SITE_URL}}/docs/vue/reference/components/billing/subscription-details-button): Clerk's <SubscriptionDetailsButton /> component renders a button that opens the Subscription details drawer.
- [`<PricingTable />`]({{SITE_URL}}/docs/vue/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/vue/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/vue/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/vue/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/vue/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/vue/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/vue/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/vue/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/vue/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/vue/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<SignUpButton>`]({{SITE_URL}}/docs/vue/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<SignOutButton>`]({{SITE_URL}}/docs/vue/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignInButton>`]({{SITE_URL}}/docs/vue/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/vue/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<UserButton />` component]({{SITE_URL}}/docs/vue/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/vue/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/vue/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/vue/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [useAuth() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-auth): Access and manage authentication state in your Vue application with Clerk's useAuth() composable.
- [useClerk() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-clerk): Access and manage the Clerk instance in your Vue application with Clerk's useClerk() composable.
- [useOrganization() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-organization): Access and manage the currently Active Organization in your Vue application with Clerk's useOrganization() composable.
- [useSessionList() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-session-list): Access and manage a list of sessions registered on the client device in your Vue application with Clerk's useSessionList() composable.
- [useSignUp() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-sign-up): Access and manage sign-up state in your Vue application with Clerk's useSignUp() composable.
- [useSignIn() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-sign-in): Access and manage sign-in state in your Vue application with Clerk's useSignIn() composable.
- [useSession() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-session): Access and manage the current user's session in your Vue application with Clerk's useSession() composable.
- [useUser() | Vue]({{SITE_URL}}/docs/vue/reference/composables/use-user): Access and manage the current user's data in your Vue application with Clerk's useUser() composable.
- [`APIKeys` object]({{SITE_URL}}/docs/vue/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Billing` object]({{SITE_URL}}/docs/vue/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Clerk` class]({{SITE_URL}}/docs/vue/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Client` object]({{SITE_URL}}/docs/vue/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [Key Clerk objects]({{SITE_URL}}/docs/vue/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Session` object]({{SITE_URL}}/docs/vue/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignInFuture` object]({{SITE_URL}}/docs/vue/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`Organization` object]({{SITE_URL}}/docs/vue/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`SignUpFuture` object]({{SITE_URL}}/docs/vue/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/vue/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`APIKeyResource`]({{SITE_URL}}/docs/vue/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/vue/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BackupCodeResource`]({{SITE_URL}}/docs/vue/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/vue/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/vue/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPayerResource`]({{SITE_URL}}/docs/vue/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/vue/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/vue/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/vue/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/vue/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/vue/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanResource`]({{SITE_URL}}/docs/vue/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/vue/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/vue/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/vue/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/vue/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/vue/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/vue/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/vue/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/vue/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/vue/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/vue/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/vue/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`CustomMenuItem`]({{SITE_URL}}/docs/vue/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/vue/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`EmailAddress`]({{SITE_URL}}/docs/vue/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/vue/reference/types/email-link-error): Custom error for email links.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/vue/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/vue/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/vue/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/vue/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/vue/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/vue/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/vue/reference/types/identification-link-resource): An interface representing an identification link.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/vue/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/vue/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/vue/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [Metadata]({{SITE_URL}}/docs/vue/reference/types/metadata): Types related to metadata.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/vue/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/vue/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/vue/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembership`]({{SITE_URL}}/docs/vue/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/vue/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/vue/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [Clerk types]({{SITE_URL}}/docs/vue/reference/types/overview): Explore the different types available for typing your application.
- [`PhoneNumber`]({{SITE_URL}}/docs/vue/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PermissionResource`]({{SITE_URL}}/docs/vue/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PasskeyResource`]({{SITE_URL}}/docs/vue/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PublicUserData`]({{SITE_URL}}/docs/vue/reference/types/public-user-data): Information about that user that's publicly available.
- [`SessionStatus`]({{SITE_URL}}/docs/vue/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`SessionTask`]({{SITE_URL}}/docs/vue/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`RoleResource`]({{SITE_URL}}/docs/vue/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`RedirectOptions`]({{SITE_URL}}/docs/vue/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionVerification`]({{SITE_URL}}/docs/vue/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/vue/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/vue/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/vue/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/vue/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/vue/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/vue/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/vue/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/vue/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/vue/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/vue/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [SSO Types]({{SITE_URL}}/docs/vue/reference/types/sso): Types related to SSO providers and strategies.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/vue/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`VerificationResource`]({{SITE_URL}}/docs/vue/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`TOTPResource`]({{SITE_URL}}/docs/vue/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`Waitlist`]({{SITE_URL}}/docs/vue/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/vue/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Nuxt Quickstart]({{SITE_URL}}/docs/nuxt/getting-started/quickstart): Add authentication and user management to your Nuxt app with Clerk.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/nuxt/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/nuxt/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/nuxt/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [`Appearance` prop]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [Bring your own CSS]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Options` prop]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Variables` prop]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`captcha` prop]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Themes]({{SITE_URL}}/docs/nuxt/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Get started with Organizations]({{SITE_URL}}/docs/nuxt/guides/organizations/getting-started): Create and manage Organizations in your app in this guided tutorial.
- [Build your own sign-in-or-up page for your Nuxt app with Clerk]({{SITE_URL}}/docs/nuxt/guides/development/custom-sign-in-or-up-page): Learn how to add a custom sign-in-or-up page to your Nuxt app with Clerk's prebuilt components.
- [Build your own sign-up page for your Nuxt app with Clerk]({{SITE_URL}}/docs/nuxt/guides/development/custom-sign-up-page): Learn how to add a custom sign-up page to your Nuxt app with Clerk's prebuilt components.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/nuxt/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Error handling]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom waitlist form]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/nuxt/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Protect content and read user data]({{SITE_URL}}/docs/nuxt/guides/users/reading): Learn how to use Clerk's composables to protect content and read user data in your Nuxt application.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/nuxt/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/nuxt/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [Component Reference]({{SITE_URL}}/docs/nuxt/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/nuxt/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<Waitlist />` component]({{SITE_URL}}/docs/nuxt/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<SignUp />` component]({{SITE_URL}}/docs/nuxt/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<SignIn />` component]({{SITE_URL}}/docs/nuxt/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<PricingTable />`]({{SITE_URL}}/docs/nuxt/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/nuxt/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/nuxt/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/nuxt/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/nuxt/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/nuxt/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/nuxt/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/nuxt/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/nuxt/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/nuxt/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<SignInButton>`]({{SITE_URL}}/docs/nuxt/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/nuxt/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<SignOutButton>`]({{SITE_URL}}/docs/nuxt/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignUpButton>`]({{SITE_URL}}/docs/nuxt/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/nuxt/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserButton />` component]({{SITE_URL}}/docs/nuxt/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserProfile />` component]({{SITE_URL}}/docs/nuxt/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [useAuth() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-auth): Access and manage authentication state in your Vue application with Clerk's useAuth() composable.
- [useClerk() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-clerk): Access and manage the Clerk instance in your Vue application with Clerk's useClerk() composable.
- [useSessionList() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-session-list): Access and manage a list of sessions registered on the client device in your Vue application with Clerk's useSessionList() composable.
- [useSession() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-session): Access and manage the current user's session in your Vue application with Clerk's useSession() composable.
- [useOrganization() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-organization): Access and manage the currently Active Organization in your Vue application with Clerk's useOrganization() composable.
- [useSignIn() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-sign-in): Access and manage sign-in state in your Vue application with Clerk's useSignIn() composable.
- [useSignUp() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-sign-up): Access and manage sign-up state in your Vue application with Clerk's useSignUp() composable.
- [useUser() | Vue]({{SITE_URL}}/docs/nuxt/reference/composables/use-user): Access and manage the current user's data in your Vue application with Clerk's useUser() composable.
- [`Clerk` class]({{SITE_URL}}/docs/nuxt/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Client` object]({{SITE_URL}}/docs/nuxt/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`APIKeys` object]({{SITE_URL}}/docs/nuxt/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Billing` object]({{SITE_URL}}/docs/nuxt/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Session` object]({{SITE_URL}}/docs/nuxt/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`Organization` object]({{SITE_URL}}/docs/nuxt/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [Key Clerk objects]({{SITE_URL}}/docs/nuxt/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`SignUpFuture` object]({{SITE_URL}}/docs/nuxt/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignInFuture` object]({{SITE_URL}}/docs/nuxt/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`User` object]({{SITE_URL}}/docs/nuxt/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/nuxt/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BackupCodeResource`]({{SITE_URL}}/docs/nuxt/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/nuxt/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPayerResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`APIKeyResource`]({{SITE_URL}}/docs/nuxt/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/nuxt/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/nuxt/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/nuxt/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/nuxt/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/nuxt/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/nuxt/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/nuxt/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/nuxt/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`ClerkAPIError`]({{SITE_URL}}/docs/nuxt/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/nuxt/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/nuxt/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`CustomMenuItem`]({{SITE_URL}}/docs/nuxt/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/nuxt/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/nuxt/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/nuxt/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/nuxt/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/nuxt/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/nuxt/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/nuxt/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`Errors`]({{SITE_URL}}/docs/nuxt/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/nuxt/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/nuxt/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/nuxt/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/nuxt/reference/types/identification-link-resource): An interface representing an identification link.
- [Metadata]({{SITE_URL}}/docs/nuxt/reference/types/metadata): Types related to metadata.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/nuxt/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/nuxt/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/nuxt/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/nuxt/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/nuxt/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembership`]({{SITE_URL}}/docs/nuxt/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/nuxt/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/nuxt/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [Clerk types]({{SITE_URL}}/docs/nuxt/reference/types/overview): Explore the different types available for typing your application.
- [`PasskeyResource`]({{SITE_URL}}/docs/nuxt/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PhoneNumber`]({{SITE_URL}}/docs/nuxt/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/nuxt/reference/types/public-user-data): Information about that user that's publicly available.
- [`PermissionResource`]({{SITE_URL}}/docs/nuxt/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`RoleResource`]({{SITE_URL}}/docs/nuxt/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`RedirectOptions`]({{SITE_URL}}/docs/nuxt/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionStatus`]({{SITE_URL}}/docs/nuxt/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`SessionTask`]({{SITE_URL}}/docs/nuxt/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/nuxt/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/nuxt/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/nuxt/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/nuxt/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/nuxt/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInInitialValues`]({{SITE_URL}}/docs/nuxt/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/nuxt/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/nuxt/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/nuxt/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/nuxt/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/nuxt/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [SSO Types]({{SITE_URL}}/docs/nuxt/reference/types/sso): Types related to SSO providers and strategies.
- [`TOTPResource`]({{SITE_URL}}/docs/nuxt/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`VerificationResource`]({{SITE_URL}}/docs/nuxt/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/nuxt/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/nuxt/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`Web3Wallet`]({{SITE_URL}}/docs/nuxt/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Astro Quickstart]({{SITE_URL}}/docs/astro/getting-started/quickstart): Add authentication and user management to your Astro app with Clerk.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/astro/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/astro/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [AI Prompts]({{SITE_URL}}/docs/astro/guides/ai/prompts): Curated prompts for working with Clerk using AI-powered IDE tools like Cursor, GitHub Copilot, and Claude.
- [Social connections (OAuth)]({{SITE_URL}}/docs/astro/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/astro/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/astro/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/astro/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Bring your own CSS]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Appearance` prop]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [Themes]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Variables` prop]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`captcha` prop]({{SITE_URL}}/docs/astro/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Error handling]({{SITE_URL}}/docs/astro/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/astro/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom waitlist form]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/astro/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/astro/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Get started with Organizations]({{SITE_URL}}/docs/astro/guides/organizations/getting-started): Create and manage Organizations in your app in this guided tutorial.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/astro/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Protect content and read user data]({{SITE_URL}}/docs/astro/guides/users/reading): Learn how to use Clerk's helpers to protect content and read user data in your Astro application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/astro/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [Component Reference]({{SITE_URL}}/docs/astro/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<Waitlist />` component]({{SITE_URL}}/docs/astro/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<SignUp />` component]({{SITE_URL}}/docs/astro/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<SignIn />` component]({{SITE_URL}}/docs/astro/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/astro/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<PricingTable />`]({{SITE_URL}}/docs/astro/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/astro/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/astro/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<Show>`]({{SITE_URL}}/docs/astro/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/astro/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/astro/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/astro/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/astro/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/astro/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<SignOutButton>`]({{SITE_URL}}/docs/astro/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignInButton>`]({{SITE_URL}}/docs/astro/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignUpButton>`]({{SITE_URL}}/docs/astro/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UserProfile />` component]({{SITE_URL}}/docs/astro/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UserButton />` component]({{SITE_URL}}/docs/astro/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/astro/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [Hooks Reference]({{SITE_URL}}/docs/astro/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [useAuth()]({{SITE_URL}}/docs/astro/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [`APIKeys` object]({{SITE_URL}}/docs/astro/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Billing` object]({{SITE_URL}}/docs/astro/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Clerk` class]({{SITE_URL}}/docs/astro/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Client` object]({{SITE_URL}}/docs/astro/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`Session` object]({{SITE_URL}}/docs/astro/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [Key Clerk objects]({{SITE_URL}}/docs/astro/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`SignInFuture` object]({{SITE_URL}}/docs/astro/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`Organization` object]({{SITE_URL}}/docs/astro/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`SignUpFuture` object]({{SITE_URL}}/docs/astro/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/astro/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BackupCodeResource`]({{SITE_URL}}/docs/astro/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/astro/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/astro/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/astro/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/astro/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`APIKeyResource`]({{SITE_URL}}/docs/astro/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/astro/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/astro/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPayerResource`]({{SITE_URL}}/docs/astro/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/astro/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/astro/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/astro/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/astro/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/astro/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementResource`]({{SITE_URL}}/docs/astro/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/astro/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/astro/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/astro/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/astro/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/astro/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/astro/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/astro/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/astro/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/astro/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/astro/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`EmailAddress`]({{SITE_URL}}/docs/astro/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/astro/reference/types/email-link-error): Custom error for email links.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/astro/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/astro/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/astro/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`ExternalAccount`]({{SITE_URL}}/docs/astro/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/astro/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`Errors`]({{SITE_URL}}/docs/astro/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/astro/reference/types/identification-link-resource): An interface representing an identification link.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/astro/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [Metadata]({{SITE_URL}}/docs/astro/reference/types/metadata): Types related to metadata.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/astro/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/astro/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/astro/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/astro/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/astro/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembership`]({{SITE_URL}}/docs/astro/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/astro/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/astro/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [Clerk types]({{SITE_URL}}/docs/astro/reference/types/overview): Explore the different types available for typing your application.
- [`PermissionResource`]({{SITE_URL}}/docs/astro/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/astro/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PasskeyResource`]({{SITE_URL}}/docs/astro/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PublicUserData`]({{SITE_URL}}/docs/astro/reference/types/public-user-data): Information about that user that's publicly available.
- [`RedirectOptions`]({{SITE_URL}}/docs/astro/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionStatus`]({{SITE_URL}}/docs/astro/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`RoleResource`]({{SITE_URL}}/docs/astro/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionTask`]({{SITE_URL}}/docs/astro/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/astro/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/astro/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/astro/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SetActiveParams`]({{SITE_URL}}/docs/astro/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInInitialValues`]({{SITE_URL}}/docs/astro/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/astro/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/astro/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/astro/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/astro/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/astro/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/astro/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [SSO Types]({{SITE_URL}}/docs/astro/reference/types/sso): Types related to SSO providers and strategies.
- [`VerificationResource`]({{SITE_URL}}/docs/astro/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/astro/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`TOTPResource`]({{SITE_URL}}/docs/astro/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`Web3Wallet`]({{SITE_URL}}/docs/astro/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [`Waitlist`]({{SITE_URL}}/docs/astro/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [Clerk Go SDK]({{SITE_URL}}/docs/go/getting-started/quickstart): Learn how to integrate Clerk into your Go application using the Clerk Go SDK.
- [Social connections (OAuth)]({{SITE_URL}}/docs/go/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [`captcha` prop]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Bring your own CSS]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Options` prop]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Variables` prop]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Themes]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Appearance` prop]({{SITE_URL}}/docs/go/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [Error handling]({{SITE_URL}}/docs/go/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/go/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom waitlist form]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/go/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Component Reference]({{SITE_URL}}/docs/go/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [TanStack React Start Quickstart]({{SITE_URL}}/docs/tanstack-react-start/getting-started/quickstart): Learn how to use Clerk to quickly and easily add secure authentication and user management to your TanStack React Start application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/tanstack-react-start/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/tanstack-react-start/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/tanstack-react-start/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [`captcha` prop]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Bring your own CSS]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Appearance` prop]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Variables` prop]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Themes]({{SITE_URL}}/docs/tanstack-react-start/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Build your own sign-in-or-up page for your TanStack React Start app with Clerk]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-sign-in-or-up-page): Learn how to add a custom sign-in-or-up page to your TanStack React Start app with Clerk's prebuilt components.
- [Build your own sign-up page for your TanStack React Start app with Clerk]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-sign-up-page): Learn how to add a custom sign-up page to your TanStack React Start app with Clerk's prebuilt components.
- [Verify OAuth access tokens in your TanStack React Start application with Clerk]({{SITE_URL}}/docs/tanstack-react-start/guides/development/verifying-oauth-access-tokens): Learn how to use Clerk's helpers to verify OAuth access tokens in your TanStack React Start application.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/tanstack-react-start/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Error handling]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom waitlist form]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/tanstack-react-start/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Protect content and read user data]({{SITE_URL}}/docs/tanstack-react-start/guides/users/reading): Learn how to use Clerk's hooks and helpers to protect content and read user data in your TanStack React Start application.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/tanstack-react-start/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [Component Reference]({{SITE_URL}}/docs/tanstack-react-start/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<SignIn />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<TaskChooseOrganization />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/task-choose-organization): Clerk's <TaskSelectComponent /> component renders a UI for resolving the choose-organization task.
- [`<SignUp />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<Waitlist />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<TaskResetPassword />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/task-reset-password): Clerk's <TaskResetPassword /> component renders a UI for resolving the reset-password task.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<TaskSetupMFA />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/authentication/task-setup-mfa): Clerk's <TaskSetupMFA /> component renders a UI for resolving the setup-mfa task.
- [`<PricingTable />`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkDegraded>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/clerk-degraded): The <ClerkDegraded> component indicates that Clerk is partially operational.
- [`<ClerkFailed>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/clerk-failed): The <ClerkFailed> component indicates that the Clerk object has failed to load.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<SignOutButton>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignUpButton>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<SignInButton>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/tanstack-react-start/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UserButton />` component]({{SITE_URL}}/docs/tanstack-react-start/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [Hooks Reference]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [useAuth()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [useClerk()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [`useOrganizationList()`]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [useReverification()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [useOrganization()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [useSessionList()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSession()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [useSignUp()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useSignIn()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useUser()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignIn()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/tanstack-react-start/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [`Client` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`APIKeys` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Clerk` class]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [Key Clerk objects]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`Organization` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`SignInFuture` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`Billing` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Session` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignUpFuture` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/tanstack-react-start/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`APIKeyResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BackupCodeResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPayerResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`EmailAddress`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailLinkError`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/identification-link-resource): An interface representing an identification link.
- [Metadata]({{SITE_URL}}/docs/tanstack-react-start/reference/types/metadata): Types related to metadata.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationMembership`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [`PasskeyResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [Clerk types]({{SITE_URL}}/docs/tanstack-react-start/reference/types/overview): Explore the different types available for typing your application.
- [`PermissionResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/public-user-data): Information about that user that's publicly available.
- [`SessionStatus`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`RoleResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`RedirectOptions`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionTask`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [SSO Types]({{SITE_URL}}/docs/tanstack-react-start/reference/types/sso): Types related to SSO providers and strategies.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`TOTPResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`VerificationResource`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/tanstack-react-start/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [React Router Quickstart]({{SITE_URL}}/docs/react-router/getting-started/quickstart): Learn how to use Clerk to quickly and easily add secure authentication and user management to your React Router application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/react-router/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/react-router/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/react-router/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Bring your own CSS]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [Themes]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Appearance` prop]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Variables` prop]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`Options` prop]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`captcha` prop]({{SITE_URL}}/docs/react-router/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Build your own sign-in-or-up page for your React Router app with Clerk]({{SITE_URL}}/docs/react-router/guides/development/custom-sign-in-or-up-page): Learn how to add a custom sign-in-or-up page to your React Router app with Clerk's prebuilt components.
- [Add React Router to your Clerk + React application]({{SITE_URL}}/docs/react-router/guides/development/declarative-mode): Learn how to add React Router to your Clerk + React application.
- [Verify OAuth access tokens in your React Router application with Clerk]({{SITE_URL}}/docs/react-router/guides/development/verifying-oauth-access-tokens): Learn how to use Clerk's helpers to verify OAuth access tokens in your React Router application.
- [Build your own sign-up page for your React Router app with Clerk]({{SITE_URL}}/docs/react-router/guides/development/custom-sign-up-page): Learn how to add a custom sign-up page to your React Router app with Clerk's prebuilt components.
- [Error handling]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom waitlist form]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/react-router/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/react-router/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Get started with Organizations]({{SITE_URL}}/docs/react-router/guides/organizations/getting-started): Create and manage Organizations in your app in this guided tutorial.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/react-router/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Protect content and read user data]({{SITE_URL}}/docs/react-router/guides/users/reading): Learn how to use Clerk's hooks and helpers to protect content and read user data in your React Router application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/react-router/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/react-router/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [Component Reference]({{SITE_URL}}/docs/react-router/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<SignUp />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<SignIn />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<TaskSetupMFA />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/task-setup-mfa): Clerk's <TaskSetupMFA /> component renders a UI for resolving the setup-mfa task.
- [`<Waitlist />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<TaskResetPassword />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/task-reset-password): Clerk's <TaskResetPassword /> component renders a UI for resolving the reset-password task.
- [`<TaskChooseOrganization />` component]({{SITE_URL}}/docs/react-router/reference/components/authentication/task-choose-organization): Clerk's <TaskSelectComponent /> component renders a UI for resolving the choose-organization task.
- [`<PricingTable />`]({{SITE_URL}}/docs/react-router/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<ClerkDegraded>`]({{SITE_URL}}/docs/react-router/reference/components/control/clerk-degraded): The <ClerkDegraded> component indicates that Clerk is partially operational.
- [`<ClerkFailed>`]({{SITE_URL}}/docs/react-router/reference/components/control/clerk-failed): The <ClerkFailed> component indicates that the Clerk object has failed to load.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/react-router/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/react-router/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/react-router/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/react-router/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/react-router/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/react-router/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/react-router/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/react-router/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/react-router/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<UserProfile />` component]({{SITE_URL}}/docs/react-router/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UserButton />` component]({{SITE_URL}}/docs/react-router/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/react-router/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<SignInButton>`]({{SITE_URL}}/docs/react-router/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignUpButton>`]({{SITE_URL}}/docs/react-router/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/react-router/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<SignOutButton>`]({{SITE_URL}}/docs/react-router/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/react-router/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [Hooks Reference]({{SITE_URL}}/docs/react-router/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [useAuth()]({{SITE_URL}}/docs/react-router/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [useClerk()]({{SITE_URL}}/docs/react-router/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/react-router/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [useReverification()]({{SITE_URL}}/docs/react-router/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [useOrganization()]({{SITE_URL}}/docs/react-router/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [`useOrganizationList()`]({{SITE_URL}}/docs/react-router/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [useSessionList()]({{SITE_URL}}/docs/react-router/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSession()]({{SITE_URL}}/docs/react-router/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [useSignIn()]({{SITE_URL}}/docs/react-router/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/react-router/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useUser()]({{SITE_URL}}/docs/react-router/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/react-router/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignUp()]({{SITE_URL}}/docs/react-router/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useSignIn()]({{SITE_URL}}/docs/react-router/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [`Organization` object]({{SITE_URL}}/docs/react-router/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`Session` object]({{SITE_URL}}/docs/react-router/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignUpFuture` object]({{SITE_URL}}/docs/react-router/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`Billing` object]({{SITE_URL}}/docs/react-router/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Client` object]({{SITE_URL}}/docs/react-router/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [Key Clerk objects]({{SITE_URL}}/docs/react-router/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Clerk` class]({{SITE_URL}}/docs/react-router/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`APIKeys` object]({{SITE_URL}}/docs/react-router/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/react-router/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignInFuture` object]({{SITE_URL}}/docs/react-router/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/react-router/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/react-router/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BackupCodeResource`]({{SITE_URL}}/docs/react-router/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/react-router/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`APIKeyResource`]({{SITE_URL}}/docs/react-router/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/react-router/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPayerResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/react-router/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/react-router/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPlanResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/react-router/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/react-router/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/react-router/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/react-router/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/react-router/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`ClerkAPIError`]({{SITE_URL}}/docs/react-router/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/react-router/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/react-router/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/react-router/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`CustomMenuItem`]({{SITE_URL}}/docs/react-router/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/react-router/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/react-router/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/react-router/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/react-router/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/react-router/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/react-router/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/react-router/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/react-router/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/react-router/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/react-router/reference/types/identification-link-resource): An interface representing an identification link.
- [`FeatureResource`]({{SITE_URL}}/docs/react-router/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/react-router/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [Metadata]({{SITE_URL}}/docs/react-router/reference/types/metadata): Types related to metadata.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/react-router/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/react-router/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/react-router/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/react-router/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/react-router/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/react-router/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/react-router/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [`OrganizationMembership`]({{SITE_URL}}/docs/react-router/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [Clerk types]({{SITE_URL}}/docs/react-router/reference/types/overview): Explore the different types available for typing your application.
- [`PasskeyResource`]({{SITE_URL}}/docs/react-router/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PhoneNumber`]({{SITE_URL}}/docs/react-router/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PermissionResource`]({{SITE_URL}}/docs/react-router/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PublicUserData`]({{SITE_URL}}/docs/react-router/reference/types/public-user-data): Information about that user that's publicly available.
- [`RedirectOptions`]({{SITE_URL}}/docs/react-router/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`RoleResource`]({{SITE_URL}}/docs/react-router/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionVerification`]({{SITE_URL}}/docs/react-router/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionTask`]({{SITE_URL}}/docs/react-router/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionStatus`]({{SITE_URL}}/docs/react-router/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`SessionWithActivities`]({{SITE_URL}}/docs/react-router/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/react-router/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/react-router/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/react-router/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/react-router/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/react-router/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/react-router/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/react-router/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/react-router/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/react-router/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [SSO Types]({{SITE_URL}}/docs/react-router/reference/types/sso): Types related to SSO providers and strategies.
- [`TOTPResource`]({{SITE_URL}}/docs/react-router/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`Waitlist`]({{SITE_URL}}/docs/react-router/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`VerificationResource`]({{SITE_URL}}/docs/react-router/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/react-router/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`Web3Wallet`]({{SITE_URL}}/docs/react-router/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Fastify Quickstart]({{SITE_URL}}/docs/fastify/getting-started/quickstart): Learn how to integrate Clerk for secure authentication and user management into your application using a Fastify backend.
- [Social connections (OAuth)]({{SITE_URL}}/docs/fastify/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/fastify/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/fastify/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Bring your own CSS]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [Themes]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Appearance` prop]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Variables` prop]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`captcha` prop]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [`Options` prop]({{SITE_URL}}/docs/fastify/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/fastify/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Error handling]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom waitlist form]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/fastify/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Component Reference]({{SITE_URL}}/docs/fastify/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [Express Quickstart]({{SITE_URL}}/docs/expressjs/getting-started/quickstart): Learn how to use Clerk to quickly and easily add secure authentication and user management to your Express server.
- [Build an MCP server in your application with Clerk]({{SITE_URL}}/docs/expressjs/guides/ai/mcp/build-mcp-server): Learn how to build an MCP server using Clerk's OAuth server in your application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/expressjs/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/expressjs/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/expressjs/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Bring your own CSS]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`captcha` prop]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [`Appearance` prop]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [Themes]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Variables` prop]({{SITE_URL}}/docs/expressjs/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Error handling]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom waitlist form]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/expressjs/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/expressjs/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Component Reference]({{SITE_URL}}/docs/expressjs/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [iOS Quickstart]({{SITE_URL}}/docs/ios/getting-started/quickstart): Add authentication and user management to your iOS app with Clerk.
- [`ClerkTheme`]({{SITE_URL}}/docs/ios/guides/customizing-clerk/clerk-theme): Utilize Clerk's ClerkTheme to adjust the general styles of the iOS views, like colors, fonts, and design properties.
- [Sign in with Apple]({{SITE_URL}}/docs/ios/guides/configure/auth-strategies/sign-in-with-apple): Learn how to use Clerk to natively sign in with Apple in your iOS app.
- [Social connections (OAuth)]({{SITE_URL}}/docs/ios/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Error handling]({{SITE_URL}}/docs/ios/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Authentication flows]({{SITE_URL}}/docs/ios/reference/native-mobile/auth): Learn how to handle sign-in, sign-up, MFA, password reset, and session management with the Clerk iOS SDK.
- [Install the SDK]({{SITE_URL}}/docs/ios/reference/native-mobile/installation): Install the Clerk iOS SDK with Swift Package Manager.
- [Welcome]({{SITE_URL}}/docs/ios/reference/native-mobile/overview): Add native authentication and user management to your app.
- [Configure the SDK]({{SITE_URL}}/docs/ios/reference/native-mobile/configuration): Configure the Clerk iOS SDK with your publishable key and options.
- [Organization management]({{SITE_URL}}/docs/ios/reference/native-mobile/organizations): Manage Organizations, Memberships, invitations, and domains with the Clerk iOS SDK.
- [Clerk]({{SITE_URL}}/docs/ios/reference/native-mobile/clerk): Use Clerk in your iOS app with shared access and SwiftUI integration.
- [User management]({{SITE_URL}}/docs/ios/reference/native-mobile/user): Manage the signed-in user with the Clerk iOS SDK.
- [Integrate Convex with Clerk]({{SITE_URL}}/docs/ios/reference/native-mobile/integrations/convex): Learn how to integrate Clerk with Convex in your native app.
- [View Reference]({{SITE_URL}}/docs/ios/reference/views/overview): A list of Clerk's comprehensive suite of views designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`AuthView`]({{SITE_URL}}/docs/ios/reference/views/authentication/auth-view): Clerk's AuthView renders a UI for signing in and signing up users on your app.
- [`UserButton`]({{SITE_URL}}/docs/ios/reference/views/user/user-button): Clerk's UserButton renders a circular button that displays the current user's profile image and opens the user profile when tapped.
- [`UserProfileView`]({{SITE_URL}}/docs/ios/reference/views/user/user-profile-view): Clerk's UserProfileView renders a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [Android Quickstart]({{SITE_URL}}/docs/android/getting-started/quickstart): Add authentication and user management to your Android app with Clerk.
- [Sign in with Google]({{SITE_URL}}/docs/android/guides/configure/auth-strategies/sign-in-with-google): Learn how to use Clerk to natively sign in with Google in your Android app.
- [Social connections (OAuth)]({{SITE_URL}}/docs/android/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [`ClerkTheme`]({{SITE_URL}}/docs/android/guides/customizing-clerk/clerk-theme): Utilize Clerk's ClerkTheme to adjust the general styles of the Android views, like colors, fonts, and design properties.
- [Error handling]({{SITE_URL}}/docs/android/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/android/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Authentication flows]({{SITE_URL}}/docs/android/reference/native-mobile/auth): Learn how to handle sign-in, sign-up, MFA, password reset, and session management with the Clerk Android SDK.
- [Clerk]({{SITE_URL}}/docs/android/reference/native-mobile/clerk): Use Clerk in your Android app with global access and reactive state flows.
- [Organization management]({{SITE_URL}}/docs/android/reference/native-mobile/organizations): Manage Organizations, Memberships, invitations, and domains with the Clerk Android SDK.
- [Install the SDK]({{SITE_URL}}/docs/android/reference/native-mobile/installation): Install the Clerk Android SDK with Gradle.
- [Configure the SDK]({{SITE_URL}}/docs/android/reference/native-mobile/configuration): Configure the Clerk Android SDK with your publishable key.
- [Welcome]({{SITE_URL}}/docs/android/reference/native-mobile/overview): Add native authentication and user management to your app.
- [User management]({{SITE_URL}}/docs/android/reference/native-mobile/user): Manage the signed-in user with the Clerk Android SDK.
- [Integrate Convex with Clerk]({{SITE_URL}}/docs/android/reference/native-mobile/integrations/convex): Learn how to integrate Clerk with Convex in your native app.
- [View Reference]({{SITE_URL}}/docs/android/reference/views/overview): A list of Clerk's comprehensive suite of views designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`UserButton`]({{SITE_URL}}/docs/android/reference/views/user/user-button): Clerk's UserButton renders a circular button that displays the current user's profile image and opens the user profile when tapped.
- [`UserProfileView`]({{SITE_URL}}/docs/android/reference/views/user/user-profile-view): Clerk's UserProfileView renders a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`AuthView`]({{SITE_URL}}/docs/android/reference/views/authentication/auth-view): Clerk's AuthView renders a UI for signing in and signing up users on your app.
- [Expo Quickstart]({{SITE_URL}}/docs/expo/getting-started/quickstart): Add authentication and user management to your Expo app with Clerk.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/expo/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/expo/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Sign in with Apple]({{SITE_URL}}/docs/expo/guides/configure/auth-strategies/sign-in-with-apple): Learn how to use Clerk to natively sign in with Apple in your Expo app.
- [Sign in with Google]({{SITE_URL}}/docs/expo/guides/configure/auth-strategies/sign-in-with-google): Learn how to use Clerk to natively sign in with Google in your Expo app.
- [Social connections (OAuth)]({{SITE_URL}}/docs/expo/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/expo/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/expo/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/expo/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Bring your own CSS]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [Themes]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Appearance` prop]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Variables` prop]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`captcha` prop]({{SITE_URL}}/docs/expo/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Error handling]({{SITE_URL}}/docs/expo/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom waitlist form]({{SITE_URL}}/docs/expo/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/expo/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/expo/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/expo/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/expo/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/expo/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Protect content and read user data]({{SITE_URL}}/docs/expo/guides/users/reading): Learn how to use Clerk's hooks to protect content and read user data in your Expo application.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/expo/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [Component Reference]({{SITE_URL}}/docs/expo/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/expo/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<SignIn />` component]({{SITE_URL}}/docs/expo/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<Waitlist />` component]({{SITE_URL}}/docs/expo/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<SignUp />` component]({{SITE_URL}}/docs/expo/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<PricingTable />`]({{SITE_URL}}/docs/expo/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<Show>`]({{SITE_URL}}/docs/expo/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/expo/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/expo/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/expo/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/expo/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/expo/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/expo/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/expo/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<SignOutButton>`]({{SITE_URL}}/docs/expo/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignInButton>`]({{SITE_URL}}/docs/expo/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignUpButton>`]({{SITE_URL}}/docs/expo/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/expo/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserButton />` component]({{SITE_URL}}/docs/expo/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserProfile />` component]({{SITE_URL}}/docs/expo/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/expo/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [Hooks Reference]({{SITE_URL}}/docs/expo/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [useAuth()]({{SITE_URL}}/docs/expo/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/expo/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [useReverification()]({{SITE_URL}}/docs/expo/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [useSessionList()]({{SITE_URL}}/docs/expo/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSignIn()]({{SITE_URL}}/docs/expo/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSession()]({{SITE_URL}}/docs/expo/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [useOrganization()]({{SITE_URL}}/docs/expo/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [`useOrganizationList()`]({{SITE_URL}}/docs/expo/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [useClerk()]({{SITE_URL}}/docs/expo/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [useSignUp()]({{SITE_URL}}/docs/expo/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useUser()]({{SITE_URL}}/docs/expo/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/expo/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignIn()]({{SITE_URL}}/docs/expo/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/expo/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [`Billing` object]({{SITE_URL}}/docs/expo/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`APIKeys` object]({{SITE_URL}}/docs/expo/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Clerk` class]({{SITE_URL}}/docs/expo/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Organization` object]({{SITE_URL}}/docs/expo/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`Client` object]({{SITE_URL}}/docs/expo/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [Key Clerk objects]({{SITE_URL}}/docs/expo/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Session` object]({{SITE_URL}}/docs/expo/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignInFuture` object]({{SITE_URL}}/docs/expo/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/expo/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignUpFuture` object]({{SITE_URL}}/docs/expo/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/expo/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/expo/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`APIKeyResource`]({{SITE_URL}}/docs/expo/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/expo/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingPayerResource`]({{SITE_URL}}/docs/expo/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BackupCodeResource`]({{SITE_URL}}/docs/expo/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/expo/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/expo/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/expo/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/expo/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/expo/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/expo/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/expo/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/expo/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/expo/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/expo/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/expo/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/expo/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingStatementResource`]({{SITE_URL}}/docs/expo/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/expo/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/expo/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/expo/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/expo/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/expo/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/expo/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/expo/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/expo/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/expo/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/expo/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/expo/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/expo/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/expo/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`ExternalAccount`]({{SITE_URL}}/docs/expo/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`Errors`]({{SITE_URL}}/docs/expo/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`FeatureResource`]({{SITE_URL}}/docs/expo/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/expo/reference/types/identification-link-resource): An interface representing an identification link.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/expo/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/expo/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [Metadata]({{SITE_URL}}/docs/expo/reference/types/metadata): Types related to metadata.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/expo/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/expo/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/expo/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/expo/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/expo/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationMembership`]({{SITE_URL}}/docs/expo/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/expo/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [Clerk types]({{SITE_URL}}/docs/expo/reference/types/overview): Explore the different types available for typing your application.
- [`PasskeyResource`]({{SITE_URL}}/docs/expo/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PermissionResource`]({{SITE_URL}}/docs/expo/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/expo/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/expo/reference/types/public-user-data): Information about that user that's publicly available.
- [`SessionStatus`]({{SITE_URL}}/docs/expo/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`RoleResource`]({{SITE_URL}}/docs/expo/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`RedirectOptions`]({{SITE_URL}}/docs/expo/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionTask`]({{SITE_URL}}/docs/expo/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/expo/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/expo/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/expo/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/expo/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/expo/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/expo/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/expo/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/expo/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/expo/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/expo/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/expo/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [SSO Types]({{SITE_URL}}/docs/expo/reference/types/sso): Types related to SSO providers and strategies.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/expo/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`TOTPResource`]({{SITE_URL}}/docs/expo/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`VerificationResource`]({{SITE_URL}}/docs/expo/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/expo/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/expo/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Chrome Extension Quickstart (Plasmo)]({{SITE_URL}}/docs/chrome-extension/getting-started/quickstart): Add authentication and user management to your Chrome Extension with Clerk using Plasmo.
- [Social connections (OAuth)]({{SITE_URL}}/docs/chrome-extension/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [`Options` prop]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Appearance` prop]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [Bring your own CSS]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`captcha` prop]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [`Variables` prop]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Themes]({{SITE_URL}}/docs/chrome-extension/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Error handling]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Build a custom waitlist form]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/chrome-extension/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/chrome-extension/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/chrome-extension/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [Component Reference]({{SITE_URL}}/docs/chrome-extension/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<Waitlist />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<SignIn />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<SignUp />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<PricingTable />`]({{SITE_URL}}/docs/chrome-extension/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<ClerkDegraded>`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/clerk-degraded): The <ClerkDegraded> component indicates that Clerk is partially operational.
- [`<ClerkFailed>`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/clerk-failed): The <ClerkFailed> component indicates that the Clerk object has failed to load.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/chrome-extension/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<SignInButton>`]({{SITE_URL}}/docs/chrome-extension/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignOutButton>`]({{SITE_URL}}/docs/chrome-extension/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignUpButton>`]({{SITE_URL}}/docs/chrome-extension/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UserButton />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/chrome-extension/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [Hooks Reference]({{SITE_URL}}/docs/chrome-extension/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [useAuth()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [`useOrganizationList()`]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [useOrganization()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [useClerk()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [useReverification()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [useSessionList()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSession()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [useSignUp()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useSignIn()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useUser()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignUp()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useSignIn()]({{SITE_URL}}/docs/chrome-extension/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [`APIKeys` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Clerk` class]({{SITE_URL}}/docs/chrome-extension/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Billing` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Client` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`Organization` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`Session` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignInFuture` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [Key Clerk objects]({{SITE_URL}}/docs/chrome-extension/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/chrome-extension/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignUpFuture` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/chrome-extension/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/chrome-extension/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BackupCodeResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/backup-code-resource): An interface that represents a backup code.
- [`APIKeyResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPayerResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`ClerkAPIError`]({{SITE_URL}}/docs/chrome-extension/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/chrome-extension/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/chrome-extension/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/chrome-extension/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/chrome-extension/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/chrome-extension/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/chrome-extension/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/chrome-extension/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EmailLinkError`]({{SITE_URL}}/docs/chrome-extension/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/chrome-extension/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/chrome-extension/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/chrome-extension/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/identification-link-resource): An interface representing an identification link.
- [`FeatureResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/chrome-extension/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [Metadata]({{SITE_URL}}/docs/chrome-extension/reference/types/metadata): Types related to metadata.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationMembership`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/chrome-extension/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [`PasskeyResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PermissionResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/chrome-extension/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [Clerk types]({{SITE_URL}}/docs/chrome-extension/reference/types/overview): Explore the different types available for typing your application.
- [`PublicUserData`]({{SITE_URL}}/docs/chrome-extension/reference/types/public-user-data): Information about that user that's publicly available.
- [`RedirectOptions`]({{SITE_URL}}/docs/chrome-extension/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionTask`]({{SITE_URL}}/docs/chrome-extension/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionStatus`]({{SITE_URL}}/docs/chrome-extension/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`RoleResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionVerification`]({{SITE_URL}}/docs/chrome-extension/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/chrome-extension/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SetActiveParams`]({{SITE_URL}}/docs/chrome-extension/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/chrome-extension/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [SSO Types]({{SITE_URL}}/docs/chrome-extension/reference/types/sso): Types related to SSO providers and strategies.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/chrome-extension/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`VerificationResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`TOTPResource`]({{SITE_URL}}/docs/chrome-extension/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`Waitlist`]({{SITE_URL}}/docs/chrome-extension/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/chrome-extension/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [JavaScript Quickstart]({{SITE_URL}}/docs/js-frontend/getting-started/quickstart): Add authentication and user management to your JavaScript app with Clerk.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/js-frontend/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/js-frontend/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/js-frontend/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [`captcha` prop]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Bring your own CSS]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Appearance` prop]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Variables` prop]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Themes]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [`Options` prop]({{SITE_URL}}/docs/js-frontend/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [Error handling]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom waitlist form]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/js-frontend/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/js-frontend/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [`<APIKeys />` component]({{SITE_URL}}/docs/js-frontend/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [Component Reference]({{SITE_URL}}/docs/js-frontend/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<SignUp />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<SignIn />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<Waitlist />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<TaskResetPassword />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/task-reset-password): Clerk's <TaskResetPassword /> component renders a UI for resolving the reset-password task.
- [`<TaskChooseOrganization />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/task-choose-organization): Clerk's <TaskSelectComponent /> component renders a UI for resolving the choose-organization task.
- [`<TaskSetupMFA />` component]({{SITE_URL}}/docs/js-frontend/reference/components/authentication/task-setup-mfa): Clerk's <TaskSetupMFA /> component renders a UI for resolving the setup-mfa task.
- [`<PricingTable />`]({{SITE_URL}}/docs/js-frontend/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/js-frontend/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/js-frontend/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/js-frontend/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/js-frontend/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/js-frontend/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/js-frontend/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/js-frontend/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/js-frontend/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UserButton />` component]({{SITE_URL}}/docs/js-frontend/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`APIKeys` object]({{SITE_URL}}/docs/js-frontend/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Billing` object]({{SITE_URL}}/docs/js-frontend/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Client` object]({{SITE_URL}}/docs/js-frontend/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`Clerk` class]({{SITE_URL}}/docs/js-frontend/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`SignInFuture` object]({{SITE_URL}}/docs/js-frontend/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [Key Clerk objects]({{SITE_URL}}/docs/js-frontend/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Session` object]({{SITE_URL}}/docs/js-frontend/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`Organization` object]({{SITE_URL}}/docs/js-frontend/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/js-frontend/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignUpFuture` object]({{SITE_URL}}/docs/js-frontend/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/js-frontend/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/js-frontend/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`APIKeyResource`]({{SITE_URL}}/docs/js-frontend/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BackupCodeResource`]({{SITE_URL}}/docs/js-frontend/reference/types/backup-code-resource): An interface that represents a backup code.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPayerResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/js-frontend/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/js-frontend/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/js-frontend/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/js-frontend/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/js-frontend/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/js-frontend/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/js-frontend/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/js-frontend/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/js-frontend/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/js-frontend/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EmailLinkError`]({{SITE_URL}}/docs/js-frontend/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/js-frontend/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/js-frontend/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/js-frontend/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/js-frontend/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/js-frontend/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/js-frontend/reference/types/identification-link-resource): An interface representing an identification link.
- [Metadata]({{SITE_URL}}/docs/js-frontend/reference/types/metadata): Types related to metadata.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [`OrganizationMembership`]({{SITE_URL}}/docs/js-frontend/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [Clerk types]({{SITE_URL}}/docs/js-frontend/reference/types/overview): Explore the different types available for typing your application.
- [`PasskeyResource`]({{SITE_URL}}/docs/js-frontend/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PermissionResource`]({{SITE_URL}}/docs/js-frontend/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/js-frontend/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/js-frontend/reference/types/public-user-data): Information about that user that's publicly available.
- [`RedirectOptions`]({{SITE_URL}}/docs/js-frontend/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`RoleResource`]({{SITE_URL}}/docs/js-frontend/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionTask`]({{SITE_URL}}/docs/js-frontend/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionStatus`]({{SITE_URL}}/docs/js-frontend/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/js-frontend/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/js-frontend/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/js-frontend/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInInitialValues`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/js-frontend/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/js-frontend/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [SSO Types]({{SITE_URL}}/docs/js-frontend/reference/types/sso): Types related to SSO providers and strategies.
- [`TOTPResource`]({{SITE_URL}}/docs/js-frontend/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`VerificationResource`]({{SITE_URL}}/docs/js-frontend/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/js-frontend/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/js-frontend/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`Web3Wallet`]({{SITE_URL}}/docs/js-frontend/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [React Quickstart]({{SITE_URL}}/docs/react/getting-started/quickstart): Add authentication and user management to your React app with Clerk.
- [AI Prompts]({{SITE_URL}}/docs/react/guides/ai/prompts): Curated prompts for working with Clerk using AI-powered IDE tools like Cursor, GitHub Copilot, and Claude.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/react/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/react/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/react/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/react/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/react/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/react/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Bring your own CSS]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Appearance` prop]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`Options` prop]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Variables` prop]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [`captcha` prop]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [Themes]({{SITE_URL}}/docs/react/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Build your own sign-in-or-up page for your React app with Clerk]({{SITE_URL}}/docs/react/guides/development/custom-sign-in-or-up-page): Learn how to add a custom sign-in-or-up page to your React app with Clerk's prebuilt components.
- [Add React Router to your Clerk + React application]({{SITE_URL}}/docs/react/guides/development/declarative-mode): Learn how to add React Router to your Clerk + React application.
- [Build your own sign-up page for your React app with Clerk]({{SITE_URL}}/docs/react/guides/development/custom-sign-up-page): Learn how to add a custom sign-up page to your React app with Clerk's prebuilt components.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/react/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Error handling]({{SITE_URL}}/docs/react/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/react/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom waitlist form]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/react/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom flow for adding a new payment method]({{SITE_URL}}/docs/react/guides/development/custom-flows/billing/add-new-payment-method): Learn how to use the Clerk API to build a custom flow for adding a new payment method to a user's account.
- [Build a custom checkout flow with a new payment method]({{SITE_URL}}/docs/react/guides/development/custom-flows/billing/checkout-new-payment-method): Learn how to use the Clerk API to build a custom checkout flow that allows users to add a new payment method during checkout.
- [Build a custom checkout flow with an existing payment method]({{SITE_URL}}/docs/react/guides/development/custom-flows/billing/checkout-existing-payment-method): Learn how to use the Clerk API to build a custom checkout flow that allows users to checkout with an existing payment method.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/react/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Get started with Organizations]({{SITE_URL}}/docs/react/guides/organizations/getting-started): Create and manage Organizations in your app in this guided tutorial.
- [Protect content and read user data]({{SITE_URL}}/docs/react/guides/users/reading): Learn how to use Clerk's hooks and helpers to protect content and read user data in your React application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/react/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [Component Reference]({{SITE_URL}}/docs/react/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/react/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/react/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<TaskResetPassword />` component]({{SITE_URL}}/docs/react/reference/components/authentication/task-reset-password): Clerk's <TaskResetPassword /> component renders a UI for resolving the reset-password task.
- [`<TaskChooseOrganization />` component]({{SITE_URL}}/docs/react/reference/components/authentication/task-choose-organization): Clerk's <TaskSelectComponent /> component renders a UI for resolving the choose-organization task.
- [`<SignUp />` component]({{SITE_URL}}/docs/react/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<TaskSetupMFA />` component]({{SITE_URL}}/docs/react/reference/components/authentication/task-setup-mfa): Clerk's <TaskSetupMFA /> component renders a UI for resolving the setup-mfa task.
- [`<SignIn />` component]({{SITE_URL}}/docs/react/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<Waitlist />` component]({{SITE_URL}}/docs/react/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<PlanDetailsButton />` component]({{SITE_URL}}/docs/react/reference/components/billing/plan-details-button): Clerk's <PlanDetailsButton /> component renders a button that opens the Plan details drawer.
- [`<CheckoutButton />` component]({{SITE_URL}}/docs/react/reference/components/billing/checkout-button): Clerk's <CheckoutButton /> component renders a button that opens the checkout drawer for Subscription Plans.
- [`<SubscriptionDetailsButton />` component]({{SITE_URL}}/docs/react/reference/components/billing/subscription-details-button): Clerk's <SubscriptionDetailsButton /> component renders a button that opens the Subscription details drawer.
- [`<PricingTable />`]({{SITE_URL}}/docs/react/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/react/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkFailed>`]({{SITE_URL}}/docs/react/reference/components/control/clerk-failed): The <ClerkFailed> component indicates that the Clerk object has failed to load.
- [`<ClerkDegraded>`]({{SITE_URL}}/docs/react/reference/components/control/clerk-degraded): The <ClerkDegraded> component indicates that Clerk is partially operational.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/react/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/react/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/react/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/react/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/react/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/react/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/react/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/react/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<SignOutButton>`]({{SITE_URL}}/docs/react/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/react/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<SignInButton>`]({{SITE_URL}}/docs/react/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignUpButton>`]({{SITE_URL}}/docs/react/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/react/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [`<UserButton />` component]({{SITE_URL}}/docs/react/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/react/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/react/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [Hooks Reference]({{SITE_URL}}/docs/react/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [`useAPIKeys()`]({{SITE_URL}}/docs/react/reference/hooks/use-api-keys): Access and manage API keys in your React application with Clerk's useAPIKeys() hook.
- [useAuth()]({{SITE_URL}}/docs/react/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [`useCheckout()`]({{SITE_URL}}/docs/react/reference/hooks/use-checkout): Clerk's useCheckout() hook provides state and methods to manage a Subscription checkout flow.
- [useOrganization()]({{SITE_URL}}/docs/react/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/react/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [useClerk()]({{SITE_URL}}/docs/react/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [`useOrganizationList()`]({{SITE_URL}}/docs/react/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [`usePaymentAttempts()`]({{SITE_URL}}/docs/react/reference/hooks/use-payment-attempts): Access and manage payment attempts in your React application with Clerk's usePaymentAttempts() hook.
- [`usePlans()`]({{SITE_URL}}/docs/react/reference/hooks/use-plans): Access Plans in your React application with Clerk's usePlans() hook.
- [`usePaymentElement()`]({{SITE_URL}}/docs/react/reference/hooks/use-payment-element): Clerk's usePaymentElement() hook provides methods and state for interacting with a payment form.
- [useReverification()]({{SITE_URL}}/docs/react/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [`usePaymentMethods()`]({{SITE_URL}}/docs/react/reference/hooks/use-payment-methods): Access and manage payment methods in your React application with Clerk's usePaymentMethods() hook.
- [useSessionList()]({{SITE_URL}}/docs/react/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSession()]({{SITE_URL}}/docs/react/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [`useStatements()`]({{SITE_URL}}/docs/react/reference/hooks/use-statements): Access and manage statements in your React application with Clerk's useStatements() hook.
- [useSignIn()]({{SITE_URL}}/docs/react/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [`useSubscription()`]({{SITE_URL}}/docs/react/reference/hooks/use-subscription): Access Subscription information in your React application with Clerk's useSubscription() hook.
- [useSignUp()]({{SITE_URL}}/docs/react/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [useUser()]({{SITE_URL}}/docs/react/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/react/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignIn()]({{SITE_URL}}/docs/react/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/react/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [`APIKeys` object]({{SITE_URL}}/docs/react/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`Billing` object]({{SITE_URL}}/docs/react/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Organization` object]({{SITE_URL}}/docs/react/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`Client` object]({{SITE_URL}}/docs/react/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [Key Clerk objects]({{SITE_URL}}/docs/react/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Clerk` class]({{SITE_URL}}/docs/react/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`Session` object]({{SITE_URL}}/docs/react/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [`SignInFuture` object]({{SITE_URL}}/docs/react/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/react/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignUpFuture` object]({{SITE_URL}}/docs/react/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/react/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/react/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BackupCodeResource`]({{SITE_URL}}/docs/react/reference/types/backup-code-resource): An interface that represents a backup code.
- [`APIKeyResource`]({{SITE_URL}}/docs/react/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/react/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingPayerResource`]({{SITE_URL}}/docs/react/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/react/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/react/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/react/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/react/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/react/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/react/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/react/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/react/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/react/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/react/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/react/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/react/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/react/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/react/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/react/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/react/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/react/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkAPIError`]({{SITE_URL}}/docs/react/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/react/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/react/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/react/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/react/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/react/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/react/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/react/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`EnterpriseAccount`]({{SITE_URL}}/docs/react/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`Errors`]({{SITE_URL}}/docs/react/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/react/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`FeatureResource`]({{SITE_URL}}/docs/react/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/react/reference/types/identification-link-resource): An interface representing an identification link.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/react/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/react/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [Metadata]({{SITE_URL}}/docs/react/reference/types/metadata): Types related to metadata.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/react/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/react/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/react/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/react/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/react/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationMembership`]({{SITE_URL}}/docs/react/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/react/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [Clerk types]({{SITE_URL}}/docs/react/reference/types/overview): Explore the different types available for typing your application.
- [`PermissionResource`]({{SITE_URL}}/docs/react/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PasskeyResource`]({{SITE_URL}}/docs/react/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [`PhoneNumber`]({{SITE_URL}}/docs/react/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/react/reference/types/public-user-data): Information about that user that's publicly available.
- [`RoleResource`]({{SITE_URL}}/docs/react/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionStatus`]({{SITE_URL}}/docs/react/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`RedirectOptions`]({{SITE_URL}}/docs/react/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`SessionTask`]({{SITE_URL}}/docs/react/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/react/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SetActiveParams`]({{SITE_URL}}/docs/react/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/react/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SessionWithActivities`]({{SITE_URL}}/docs/react/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SignInInitialValues`]({{SITE_URL}}/docs/react/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/react/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/react/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/react/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/react/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/react/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/react/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [SSO Types]({{SITE_URL}}/docs/react/reference/types/sso): Types related to SSO providers and strategies.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/react/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`TOTPResource`]({{SITE_URL}}/docs/react/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`VerificationResource`]({{SITE_URL}}/docs/react/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/react/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/react/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Next.js Quickstart (App Router)]({{SITE_URL}}/docs/nextjs/getting-started/quickstart): Add authentication and user management to your Next.js app.
- [AI Prompts]({{SITE_URL}}/docs/nextjs/guides/ai/prompts): Curated prompts for working with Clerk using AI-powered IDE tools like Cursor, GitHub Copilot, and Claude.
- [Build an MCP server in your application with Clerk]({{SITE_URL}}/docs/nextjs/guides/ai/mcp/build-mcp-server): Learn how to build an MCP server using Clerk's OAuth server in your application.
- [Clerk Billing for B2B SaaS]({{SITE_URL}}/docs/nextjs/guides/billing/for-b2b): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Clerk Billing for B2C SaaS]({{SITE_URL}}/docs/nextjs/guides/billing/for-b2c): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Social connections (OAuth)]({{SITE_URL}}/docs/nextjs/guides/configure/auth-strategies/social-connections/overview): Learn how to effortlessly add social connections to your application using popular social providers like Google, Facebook, GitHub and more.
- [Add custom pages and links to the `<OrganizationProfile />` component]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/adding-items/organization-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <OrganizationProfile /> component.
- [Add custom items and links to the `<UserButton />` component]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/adding-items/user-button): Learn how to add custom items and include external links within the <UserButton /> menu.
- [Add custom pages and links to the `<UserProfile />` component]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/adding-items/user-profile): Learn how to add custom pages and include external links within the navigation sidenav of the <UserProfile /> component.
- [Bring your own CSS]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/bring-your-own-css): Learn how to bring your own CSS to Clerk's prebuilt components.
- [`Options` prop]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/options): Utilize Clerk's options prop in order to change the layout of the <SignIn /> and <SignUp /> components, as well as set important links to your support, terms and privacy pages.
- [`Appearance` prop]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/overview): Utilize Clerk's appearance property in order to share styles across every component or individually to any of the Clerk components.
- [`captcha` prop]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/captcha): Utilize Clerk's captcha prop in order to change the appearance of the CAPTCHA widget.
- [`Variables` prop]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/variables): Utilize Clerk's variables property in order to adjust the general styles of the component's base theme, like colors, backgrounds, typography.
- [Themes]({{SITE_URL}}/docs/nextjs/guides/customizing-clerk/appearance-prop/themes): Clerk currently offers six prebuilt themes for you to customize the overall appearance of your Clerk app.
- [Build your own sign-in-or-up page for your Next.js app with Clerk]({{SITE_URL}}/docs/nextjs/guides/development/custom-sign-in-or-up-page): Learn how to add a custom sign-in-or-up page to your Next.js app with Clerk's prebuilt components.
- [Build your own sign-up page for your Next.js app with Clerk]({{SITE_URL}}/docs/nextjs/guides/development/custom-sign-up-page): Learn how to add a custom sign-up page to your Next.js app with Clerk's prebuilt components.
- [Verify OAuth access tokens in your Next.js application with Clerk]({{SITE_URL}}/docs/nextjs/guides/development/verifying-oauth-access-tokens): Learn how to use Clerk's helpers to verify OAuth access tokens in your Next.js application.
- [Error handling]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/error-handling): Provide your users with useful information about the errors being returned from sign-up and sign-in requests.
- [Build a custom flow for handling user impersonation]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/account-updates/user-impersonation): Learn how to build a custom flow using the Clerk API that handles user impersonation.
- [Add bot protection to your custom sign-up flow]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/bot-sign-up-protection): Learn how to add Clerk's bot protection to your custom sign-up flow.
- [Build a custom Google One Tap authentication flow]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/google-one-tap): Learn how to build a custom Google One Tap authentication flow using the Clerk API.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Build a custom waitlist form]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/waitlist): Learn how to use the Clerk API to build a custom waitlist form using Clerk's useWaitlist() hook.
- [Build a custom flow for handling email links]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/legacy/email-links): Learn how to build a custom flow using Clerk's API to handle email links for sign-up, sign-in, and email address verification.
- [Embeddable email links with sign-in tokens]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/authentication/legacy/embedded-email-links): Learn how to build custom embeddable email link sign-in flows to increase user engagement and reduce drop off in transactional emails, SMS's, and more.
- [Build a custom checkout flow with an existing payment method]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/billing/checkout-existing-payment-method): Learn how to use the Clerk API to build a custom checkout flow that allows users to checkout with an existing payment method.
- [Build a custom checkout flow with a new payment method]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/billing/checkout-new-payment-method): Learn how to use the Clerk API to build a custom checkout flow that allows users to add a new payment method during checkout.
- [Build a custom flow for adding a new payment method]({{SITE_URL}}/docs/nextjs/guides/development/custom-flows/billing/add-new-payment-method): Learn how to use the Clerk API to build a custom flow for adding a new payment method to a user's account.
- [Clerk Billing webhooks]({{SITE_URL}}/docs/nextjs/guides/development/webhooks/billing): Clerk Billing webhooks allow you to track Subscription lifecycles and monitor payment attempts.
- [Get started with Organizations]({{SITE_URL}}/docs/nextjs/guides/organizations/getting-started): Create and manage Organizations in your app in this guided tutorial.
- [Set up a waitlist in your app]({{SITE_URL}}/docs/nextjs/guides/secure/waitlist): Learn how to add a waitlist to your application.
- [Protect content and read user data]({{SITE_URL}}/docs/nextjs/guides/users/reading): Learn how to use Clerk's hooks and helpers to protect content and read user data in your Next.js application.
- [`<APIKeys />` component]({{SITE_URL}}/docs/nextjs/reference/components/api-keys): Clerk's <APIKeys /> component renders a UI to manage API keys.
- [`<ClerkProvider>`]({{SITE_URL}}/docs/nextjs/reference/components/clerk-provider): The <ClerkProvider> component provides session and user context to Clerk's hooks and components.
- [Component Reference]({{SITE_URL}}/docs/nextjs/reference/components/overview): A list of Clerk's comprehensive suite of components designed to seamlessly integrate authentication and multi-tenancy into your application.
- [`<GoogleOneTap />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/google-one-tap): Clerk's <GoogleOneTap /> component renders a UI for authenticating users with Google's One Tap API.
- [`<SignUp />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/sign-up): Clerk's <SignUp /> component renders a UI for signing up users.
- [`<SignIn />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/sign-in): Clerk's <SignIn /> component renders a UI for signing in users.
- [`<TaskResetPassword />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/task-reset-password): Clerk's <TaskResetPassword /> component renders a UI for resolving the reset-password task.
- [`<TaskChooseOrganization />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/task-choose-organization): Clerk's <TaskSelectComponent /> component renders a UI for resolving the choose-organization task.
- [`<TaskSetupMFA />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/task-setup-mfa): Clerk's <TaskSetupMFA /> component renders a UI for resolving the setup-mfa task.
- [`<Waitlist />` component]({{SITE_URL}}/docs/nextjs/reference/components/authentication/waitlist): The <Waitlist /> component renders a waitlist form that allows users to join for early access to your application.
- [`<PlanDetailsButton />` component]({{SITE_URL}}/docs/nextjs/reference/components/billing/plan-details-button): Clerk's <PlanDetailsButton /> component renders a button that opens the Plan details drawer.
- [`<CheckoutButton />` component]({{SITE_URL}}/docs/nextjs/reference/components/billing/checkout-button): Clerk's <CheckoutButton /> component renders a button that opens the checkout drawer for Subscription Plans.
- [`<PricingTable />`]({{SITE_URL}}/docs/nextjs/reference/components/billing/pricing-table): Clerk's <PricingTable /> component displays a table of Plans and Features that users can subscribe to.
- [`<SubscriptionDetailsButton />` component]({{SITE_URL}}/docs/nextjs/reference/components/billing/subscription-details-button): Clerk's <SubscriptionDetailsButton /> component renders a button that opens the Subscription details drawer.
- [`<ClerkLoaded>`]({{SITE_URL}}/docs/nextjs/reference/components/control/clerk-loaded): The <ClerkLoaded> component guarantees that the Clerk object has loaded and will be available under window.Clerk. This allows you to wrap child components to access the Clerk object without the need to check it exists.
- [`<RedirectToCreateOrganization />` (deprecated)]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-create-organization): The <RedirectToCreateOrganization /> component will navigate to the create Organization flow which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignUp />`]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-sign-up): The <RedirectToSignUp /> component will navigate to the sign up URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToSignIn />`]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-sign-in): The <RedirectToSignIn /> component will navigate to the sign in URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<ClerkLoading>`]({{SITE_URL}}/docs/nextjs/reference/components/control/clerk-loading): The <ClerkLoading> renders its children while Clerk is loading, and is helpful for showing a custom loading state.
- [`<RedirectToOrganizationProfile />` (deprecated)]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-organization-profile): The <RedirectToOrganizationProfile /> component will navigate to the Organization profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<AuthenticateWithRedirectCallback />`]({{SITE_URL}}/docs/nextjs/reference/components/control/authenticate-with-redirect-callback): Clerk's <AuthenticateWithRedirectCallback /> component is used to implement custom OAuth flows. It handles the OAuth callback and completes the authentication process.
- [`<ClerkDegraded>`]({{SITE_URL}}/docs/nextjs/reference/components/control/clerk-degraded): The <ClerkDegraded> component indicates that Clerk is partially operational.
- [`<ClerkFailed>`]({{SITE_URL}}/docs/nextjs/reference/components/control/clerk-failed): The <ClerkFailed> component indicates that the Clerk object has failed to load.
- [`<RedirectToTasks />`]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-tasks): The <RedirectToTasks /> component will navigate to the tasks flow which has been configured in your application instance when users have pending session tasks. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<RedirectToUserProfile />` (deprecated)]({{SITE_URL}}/docs/nextjs/reference/components/control/redirect-to-user-profile): The <RedirectToUserProfile /> component will navigate to the user profile URL which has been configured in your application instance. The behavior will be just like a server-side (3xx) redirect, and will override the current location in the history stack.
- [`<Show>`]({{SITE_URL}}/docs/nextjs/reference/components/control/show): The Show component protects content or even entire routes based on authentication, and optionally, authorization.
- [`<CreateOrganization />` component]({{SITE_URL}}/docs/nextjs/reference/components/organization/create-organization): Clerk's <CreateOrganization /> component is used to render an Organization creation UI that allows users to create brand new Organizations within your application.
- [`<OrganizationProfile />` component]({{SITE_URL}}/docs/nextjs/reference/components/organization/organization-profile): Clerk's <OrganizationProfile /> component is used to render a beautiful, full-featured Organization management UI that allows users to manage their Organization profile and security settings.
- [`<OrganizationList />` component]({{SITE_URL}}/docs/nextjs/reference/components/organization/organization-list): Clerk's <OrganizationList /> component is used to display Organization related memberships, invitations, and suggestions for the user.
- [`<OrganizationSwitcher />` component]({{SITE_URL}}/docs/nextjs/reference/components/organization/organization-switcher): Clerk's <OrganizationSwitcher /> component is used to enable the ability to switch between available Organizations the user may be part of in your application.
- [`<SignInWithMetamaskButton>`]({{SITE_URL}}/docs/nextjs/reference/components/unstyled/sign-in-with-metamask): The <SignInWithMetamaskButton> component is used to complete a one-click, cryptographically-secure sign-in flow using MetaMask.
- [`<SignOutButton>`]({{SITE_URL}}/docs/nextjs/reference/components/unstyled/sign-out-button): The <SignOutButton> component is a button that signs a user out.
- [`<SignInButton>`]({{SITE_URL}}/docs/nextjs/reference/components/unstyled/sign-in-button): The <SignInButton> component is a button that links to the sign-in page or displays the sign-in modal.
- [`<SignUpButton>`]({{SITE_URL}}/docs/nextjs/reference/components/unstyled/sign-up-button): The <SignUpButton> component is a button that links to the sign-up page or displays the sign-up modal.
- [`<UserAvatar />` component]({{SITE_URL}}/docs/nextjs/reference/components/user/user-avatar): Clerk's <UserAvatar /> component is used to render the familiar user avatar on its own.
- [`<UserProfile />` component]({{SITE_URL}}/docs/nextjs/reference/components/user/user-profile): Clerk's <UserProfile /> component is used to render a beautiful, full-featured account management UI that allows users to manage their profile and security settings.
- [`<UserButton />` component]({{SITE_URL}}/docs/nextjs/reference/components/user/user-button): Clerk's <UserButton /> component is used to render the familiar user button UI popularized by Google.
- [`<UNSAFE_PortalProvider>` component]({{SITE_URL}}/docs/nextjs/reference/components/utilities/portal-provider): Clerk's <UNSAFE_PortalProvider> component is used to render Clerk floating UI elements inside custom containers instead of document.body.
- [Hooks Reference]({{SITE_URL}}/docs/nextjs/reference/hooks/overview): A list of Clerk's comprehensive suite of hooks for managing authentication, sessions, sign-in and sign-up flows, Organizations, and reverification.
- [`useAPIKeys()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-api-keys): Access and manage API keys in your React application with Clerk's useAPIKeys() hook.
- [useAuth()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-auth): Access and manage authentication state in your application with Clerk's useAuth() hook.
- [useClerk()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-clerk): Access and manage the Clerk object in your React application with Clerk's useClerk() hook.
- [useOrganizationCreationDefaults()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-organization-creation-defaults): Retrieve organization creation defaults for the current user in your React application with Clerk's useOrganizationCreationDefaults() hook.
- [`useCheckout()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-checkout): Clerk's useCheckout() hook provides state and methods to manage a Subscription checkout flow.
- [`useOrganizationList()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-organization-list): Access and manage the current user's Organization list in your React application with Clerk's useOrganizationList() hook.
- [useOrganization()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-organization): Access and manage the currently active Organization in your React application with Clerk's useOrganization() hook.
- [`usePaymentMethods()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-payment-methods): Access and manage payment methods in your React application with Clerk's usePaymentMethods() hook.
- [`usePaymentAttempts()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-payment-attempts): Access and manage payment attempts in your React application with Clerk's usePaymentAttempts() hook.
- [`usePlans()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-plans): Access Plans in your React application with Clerk's usePlans() hook.
- [`usePaymentElement()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-payment-element): Clerk's usePaymentElement() hook provides methods and state for interacting with a payment form.
- [useReverification()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-reverification): Clerk's useReverification() hook enhances a fetcher function to handle a session's reverification flow.
- [useSessionList()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-session-list): Access and manage the current user's session list in your React application with Clerk's useSessionList() hook.
- [useSession()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-session): Access and manage the current user's session in your React application with Clerk's useSession() hook.
- [useSignIn()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [`useStatements()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-statements): Access and manage statements in your React application with Clerk's useStatements() hook.
- [`useSubscription()`]({{SITE_URL}}/docs/nextjs/reference/hooks/use-subscription): Access Subscription information in your React application with Clerk's useSubscription() hook.
- [useUser()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-user): Access and manage the current user's data in your React application with Clerk's useUser() hook.
- [useWaitlist()]({{SITE_URL}}/docs/nextjs/reference/hooks/use-waitlist): Access and manage the waitlist state in your React application with Clerk's useWaitlist() hook.
- [useSignIn()]({{SITE_URL}}/docs/nextjs/reference/hooks/legacy/use-sign-in): Access and manage the current user's sign-in state in your React application with Clerk's useSignIn() hook.
- [useSignUp()]({{SITE_URL}}/docs/nextjs/reference/hooks/legacy/use-sign-up): Access and manage the current user's sign-up state in your React application with Clerk's useSignUp() hook.
- [`Billing` object]({{SITE_URL}}/docs/nextjs/reference/objects/billing): The Billing object provides methods for managing billing for a user or organization.
- [`Organization` object]({{SITE_URL}}/docs/nextjs/reference/objects/organization): The Organization object holds information about an Organization, as well as methods for managing it.
- [`Session` object]({{SITE_URL}}/docs/nextjs/reference/objects/session): The Session object is an abstraction over an HTTP session. It models the period of information exchange between a user and the server.
- [Key Clerk objects]({{SITE_URL}}/docs/nextjs/reference/objects/overview): Learn about the key objects that power Clerk's SDKs, like the Clerk, User, and Session objects.
- [`Client` object]({{SITE_URL}}/docs/nextjs/reference/objects/client): The Client object keeps track of the authenticated sessions in the current device. The device can be a browser, a native application or any other medium that is usually the requesting part in a request/response architecture.
- [`Clerk` class]({{SITE_URL}}/docs/nextjs/reference/objects/clerk): The Clerk object contains a number of methods and properties for interacting with the Clerk API.
- [`APIKeys` object]({{SITE_URL}}/docs/nextjs/reference/objects/api-keys): The APIKeys object provides methods for creating, listing, and revoking API keys that allow users to grant third-party services programmatic access to your application's API endpoints.
- [`SignInFuture` object]({{SITE_URL}}/docs/nextjs/reference/objects/sign-in-future): The SignInFuture object holds the state of the current sign-in and provides helper methods to navigate and complete the sign-in process.
- [`SignIn` object (Legacy)]({{SITE_URL}}/docs/nextjs/reference/objects/sign-in): The SignIn object holds all the state of the current sign in and provides helper methods to navigate and complete the sign in process.
- [`SignUpFuture` object]({{SITE_URL}}/docs/nextjs/reference/objects/sign-up-future): The SignUpFuture object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`SignUp` object (Legacy)]({{SITE_URL}}/docs/nextjs/reference/objects/sign-up): The SignUp object holds the state of the current sign-up and provides helper methods to navigate and complete the sign-up flow.
- [`User` object]({{SITE_URL}}/docs/nextjs/reference/objects/user): The User object holds all the information for a user of your application and provides a set of methods to manage their account. Users have a unique authentication identifier which might be their email address, phone number or a username.
- [`BackupCodeResource`]({{SITE_URL}}/docs/nextjs/reference/types/backup-code-resource): An interface that represents a backup code.
- [`APIKeyResource`]({{SITE_URL}}/docs/nextjs/reference/types/api-key-resource): An interface that describes an API key used to authenticate requests to your application's API endpoints.
- [`BillingCheckoutTotals`]({{SITE_URL}}/docs/nextjs/reference/types/billing-checkout-totals): The BillingCheckoutTotals type represents the total costs, taxes, and other pricing details for a checkout session.
- [`BillingCheckoutResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-checkout-resource): The BillingCheckoutResource type represents information about a checkout session.
- [`BillingPayerResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-payer-resource): The BillingPayerResource class represents a payer associated with a Billing Subscription.
- [`BillingMoneyAmount`]({{SITE_URL}}/docs/nextjs/reference/types/billing-money-amount): The BillingMoneyAmount type represents a monetary value with currency information.
- [`BillingPaymentMethodResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-payment-method-resource): The BillingPaymentMethodResource type represents a payment source for a checkout session.
- [`BillingPaymentResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-payment-resource): The BillingPaymentResource type represents a payment attempt for a user or Organization.
- [`BillingPerUnitTotalTier`]({{SITE_URL}}/docs/nextjs/reference/types/billing-per-unit-total-tier): The BillingPerUnitTotalTier type represents a tiered pricing structure for billing based on unit usage.
- [`BillingPerUnitTotal`]({{SITE_URL}}/docs/nextjs/reference/types/billing-per-unit-total): The BillingPerUnitTotal type represents the total cost for a billing period based on unit usage.
- [`BillingPlanResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-plan-resource): The BillingPlanResource type represents a Subscription Plan with its details.
- [`BillingPlanUnitPriceTier`]({{SITE_URL}}/docs/nextjs/reference/types/billing-plan-unit-price-tier): The BillingPlanUnitPriceTier type represents a single pricing tier for a unit type on a plan.
- [`BillingPlanUnitPrice`]({{SITE_URL}}/docs/nextjs/reference/types/billing-plan-unit-price): The BillingPlanUnitPrice type represents unit pricing for a specific unit type (for example, seats) on a plan.
- [`BillingStatementTotals`]({{SITE_URL}}/docs/nextjs/reference/types/billing-statement-totals): The BillingStatementTotals type represents the total costs, taxes, and other pricing details for a statement.
- [`BillingStatementGroup`]({{SITE_URL}}/docs/nextjs/reference/types/billing-statement-group): The BillingStatementGroup type represents a group of payment items within a statement.
- [`BillingStatementResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-statement-resource): The BillingStatementResource type represents a billing statement for a user or Organization.
- [`BillingSubscriptionItemResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-subscription-item-resource): The BillingSubscriptionItemResource type represents an item in a Subscription.
- [`BillingSubscriptionItemSeats`]({{SITE_URL}}/docs/nextjs/reference/types/billing-subscription-item-seats): The BillingSubscriptionItemSeats type represents seat entitlements attached to a subscription item.
- [`BillingSubscriptionResource`]({{SITE_URL}}/docs/nextjs/reference/types/billing-subscription-resource): The BillingSubscriptionResource type represents a Subscription to a Plan.
- [`ClerkAPIError`]({{SITE_URL}}/docs/nextjs/reference/types/clerk-api-error): An interface that represents an error returned by the Clerk API.
- [`ClerkAPIResponseError`]({{SITE_URL}}/docs/nextjs/reference/types/clerk-api-response-error): An interface that represents an error returned by the Clerk API.
- [`ClerkError`]({{SITE_URL}}/docs/nextjs/reference/types/clerk-error): Type used for all errors generated by the Clerk SDK.
- [`ClerkPaginatedResponse`]({{SITE_URL}}/docs/nextjs/reference/types/clerk-paginated-response): An interface that describes the response of a method that returns a paginated list of resources.
- [`CustomMenuItem`]({{SITE_URL}}/docs/nextjs/reference/types/custom-menu-item): An interface that provides the ability to add custom menu item to the <UserButton /> component.
- [`CustomPage`]({{SITE_URL}}/docs/nextjs/reference/types/custom-page): An interface that provides the ability to add custom pages to the <UserProfile /> or <OrganizationProfile /> components.
- [`DeletedObjectResource`]({{SITE_URL}}/docs/nextjs/reference/types/deleted-object-resource): The DeletedObjectResource class represents an item that has been deleted from the database.
- [`EmailAddress`]({{SITE_URL}}/docs/nextjs/reference/types/email-address): The EmailAddress object is a model around an email address.
- [`EmailLinkError`]({{SITE_URL}}/docs/nextjs/reference/types/email-link-error): Custom error for email links.
- [`EnterpriseAccountConnection`]({{SITE_URL}}/docs/nextjs/reference/types/enterprise-account-connection): An interface that represents an enterprise account connection.
- [`Errors`]({{SITE_URL}}/docs/nextjs/reference/types/errors): An interface that represents the errors that occurred during the last API request, for use in custom flows.
- [`ExternalAccount`]({{SITE_URL}}/docs/nextjs/reference/types/external-account): The ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [`EnterpriseAccount`]({{SITE_URL}}/docs/nextjs/reference/types/enterprise-account): An interface that represents an enterprise account.
- [`FeatureResource`]({{SITE_URL}}/docs/nextjs/reference/types/feature-resource): The FeatureResource type represents a Feature of a Subscription Plan.
- [`IdentificationLinkResource`]({{SITE_URL}}/docs/nextjs/reference/types/identification-link-resource): An interface representing an identification link.
- [`LastAuthenticationStrategy`]({{SITE_URL}}/docs/nextjs/reference/types/last-authentication-strategy): The LastAuthenticationStrategy enum is used to indicate the last authentication strategy used by a client.
- [Metadata]({{SITE_URL}}/docs/nextjs/reference/types/metadata): Types related to metadata.
- [`OrganizationCreationDefaults`]({{SITE_URL}}/docs/nextjs/reference/types/organization-creation-defaults): An interface representing an Organization creation defaults.
- [`OrganizationCustomPermissionKey`]({{SITE_URL}}/docs/nextjs/reference/types/organization-custom-permission-key): A type that represents a user's Permission in an organization.
- [`OrganizationCustomRoleKey`]({{SITE_URL}}/docs/nextjs/reference/types/organization-custom-role-key): A type that represents the user's Role in an Organization.
- [`OrganizationDomainResource`]({{SITE_URL}}/docs/nextjs/reference/types/organization-domain-resource): The OrganizationDomainResource object is the model around an Organization domain.
- [`OrganizationMembershipRequest`]({{SITE_URL}}/docs/nextjs/reference/types/organization-membership-request): The OrganizationMembershipRequest object is the model that describes the request of a user to join an Organization.
- [`OrganizationInvitation`]({{SITE_URL}}/docs/nextjs/reference/types/organization-invitation): The OrganizationInvitation object is the model around an Organization invitation.
- [`OrganizationMembership`]({{SITE_URL}}/docs/nextjs/reference/types/organization-membership): The OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [`OrganizationSuggestion`]({{SITE_URL}}/docs/nextjs/reference/types/organization-suggestion): An interface representing an Organization suggestion.
- [`PasskeyResource`]({{SITE_URL}}/docs/nextjs/reference/types/passkey-resource): An interface that describes a passkey associated with a user response.
- [Clerk types]({{SITE_URL}}/docs/nextjs/reference/types/overview): Explore the different types available for typing your application.
- [`PermissionResource`]({{SITE_URL}}/docs/nextjs/reference/types/permission-resource): An interface that represents a Permission in an Organization.
- [`PhoneNumber`]({{SITE_URL}}/docs/nextjs/reference/types/phone-number): The PhoneNumber object describes a phone number. Phone numbers can be used as a proof of identification for users, or simply as a means of contacting users.
- [`PublicUserData`]({{SITE_URL}}/docs/nextjs/reference/types/public-user-data): Information about that user that's publicly available.
- [`RedirectOptions`]({{SITE_URL}}/docs/nextjs/reference/types/redirect-options): An interface that provides options for a range of redirect methods.
- [`RoleResource`]({{SITE_URL}}/docs/nextjs/reference/types/role-resource): An interface that represents a Role in an Organization.
- [`SessionStatus`]({{SITE_URL}}/docs/nextjs/reference/types/session-status): The SessionStatus enum is used to indicate the status of a session.
- [`SessionVerification`]({{SITE_URL}}/docs/nextjs/reference/types/session-verification): The SessionVerification interface represents the state of a session reverification process.
- [`SessionTask`]({{SITE_URL}}/docs/nextjs/reference/types/session-task): The SessionTask interface represents the current pending task of a session.
- [`SessionWithActivities`]({{SITE_URL}}/docs/nextjs/reference/types/session-with-activities): The SessionWithActivities object is a modified Session object. It contains most of the information that the Session object stores, adding extra information about the current session's latest activity.
- [`SetActiveParams`]({{SITE_URL}}/docs/nextjs/reference/types/set-active-params): The parameters for the setActive() method.
- [`SignInFirstFactor`]({{SITE_URL}}/docs/nextjs/reference/types/sign-in-first-factor): The SignInFirstFactor type represents the first factor verification strategy that can be used in the sign-in process.
- [`SignInInitialValues`]({{SITE_URL}}/docs/nextjs/reference/types/sign-in-initial-values): The type for the initialValues prop that is used to pre-populate the sign-in form.
- [`SignInRedirectOptions`]({{SITE_URL}}/docs/nextjs/reference/types/sign-in-redirect-options): An interface that provides options for sign-in redirect methods.
- [`SignUpRedirectOptions`]({{SITE_URL}}/docs/nextjs/reference/types/sign-up-redirect-options): An interface that provides options for sign-up redirect methods.
- [`SignUpInitialValues`]({{SITE_URL}}/docs/nextjs/reference/types/sign-up-initial-values): The type for the initialValues prop that is used to pre-populate the sign-up form.
- [`SignInSecondFactor`]({{SITE_URL}}/docs/nextjs/reference/types/sign-in-second-factor): The SignInSecondFactor type represents the second factor verification strategy that can be used in the sign-in process.
- [`SignUpVerificationResource`]({{SITE_URL}}/docs/nextjs/reference/types/sign-up-verification-resource): An interface that represents the available verification strategies for a sign-up attempt.
- [SSO Types]({{SITE_URL}}/docs/nextjs/reference/types/sso): Types related to SSO providers and strategies.
- [`TOTPResource`]({{SITE_URL}}/docs/nextjs/reference/types/totp-resource): An interface that represents a TOTP secret.
- [`SignedInSessionResource`]({{SITE_URL}}/docs/nextjs/reference/types/signed-in-session-resource): A session for a logged-in user that is either fully active or waiting to complete additional verification steps.
- [`UserOrganizationInvitation`]({{SITE_URL}}/docs/nextjs/reference/types/user-organization-invitation): The UserOrganizationInvitation object is the model around a user's invitation to an Organization.
- [`VerificationResource`]({{SITE_URL}}/docs/nextjs/reference/types/verification-resource): An interface that represents the state of the verification process for a sign-in or sign-up attempt.
- [`Waitlist`]({{SITE_URL}}/docs/nextjs/reference/types/waitlist): The Waitlist object holds the state of a waitlist entry and provides methods to join the waitlist.
- [`Web3Wallet`]({{SITE_URL}}/docs/nextjs/reference/types/web3-wallet): The Web3Wallet object describes a Web3 wallet address. The address can be used as a proof of identification for users.
- [Core concepts]({{SITE_URL}}/docs/getting-started/core-concepts): Learn about the main concepts and objects that drive Clerk's powerful authentication and user management system.
- [Set up your Clerk account]({{SITE_URL}}/docs/getting-started/quickstart/setup-clerk): Set up a new Clerk account and integrate it into a new application.
- [Quickstarts]({{SITE_URL}}/docs/getting-started/quickstart/overview): See the getting started guides and tutorials.
- [Next.js Quickstart (Pages Router)]({{SITE_URL}}/docs/getting-started/quickstart/pages-router): Add authentication and user management to your Next.js app with Clerk.
- [Chrome Extension Quickstart (JavaScript)]({{SITE_URL}}/docs/getting-started/quickstart/chrome-extension-js): Add authentication and user management to your Chrome Extension with Clerk using plain TypeScript and esbuild.
- [SDK References]({{SITE_URL}}/docs/reference/overview): Learn about the Clerk and community SDK's available for integrating Clerk into your application.
- [Ruby on Rails integration]({{SITE_URL}}/docs/reference/ruby/rails): The Clerk Ruby SDK provides a Rack middleware and a gem to integrate Clerk into your Rails app.
- [Clerk Ruby SDK]({{SITE_URL}}/docs/reference/ruby/overview): The Clerk Ruby SDK provides a range of backend utilities to simplify user authentication and management in your application.
- [Ruby with Rack]({{SITE_URL}}/docs/reference/ruby/rack): The Clerk Ruby SDK provides a Rack middleware to integrate Clerk into your Rack-based application.
- [Upgrade to `clerk-sdk-ruby` v4]({{SITE_URL}}/docs/reference/ruby/v4-upgrade-guide): Learn how to upgrade your application to use Clerk Ruby SDK v4.
- [Upgrade to `clerk-sdk-ruby` v5]({{SITE_URL}}/docs/reference/ruby/v5-upgrade-guide): Learn how to upgrade your application to use Clerk Ruby SDK v5.
- [Sinatra integration]({{SITE_URL}}/docs/reference/ruby/sinatra): The Clerk Ruby SDK provides a Sinatra extension to integrate Clerk into your Sinatra app.
- [`updateClerkOptions()`]({{SITE_URL}}/docs/reference/vue/update-clerk-options): The updateClerkOptions() function allows you to update Clerk's options at runtime.
- [Clerk Vue SDK]({{SITE_URL}}/docs/reference/vue/overview): The Clerk Vue SDK gives you access to prebuilt components, composables, and helpers to make user authentication easier.
- [`clerkPlugin`]({{SITE_URL}}/docs/reference/vue/clerk-plugin): The clerkPlugin provides session and user context to Clerk's composables and components.
- [clerkMiddleware() | Nuxt]({{SITE_URL}}/docs/reference/nuxt/clerk-middleware): The clerkMiddleware() helper allows you to protect your Nuxt application using middleware.
- [`@clerk/nuxt` module]({{SITE_URL}}/docs/reference/nuxt/integration): The @clerk/nuxt module provides session and user context to Clerk's composables and components.
- [Clerk Nuxt SDK]({{SITE_URL}}/docs/reference/nuxt/overview): The Clerk Nuxt SDK gives you access to prebuilt components, composables, and helpers to make user authentication easier.
- [Integration]({{SITE_URL}}/docs/reference/astro/integration): The Astro integration provides session and user context to Clerk's hooks and components.
- [`clerkMiddleware()` | Astro]({{SITE_URL}}/docs/reference/astro/clerk-middleware): The clerkMiddleware() function allows you to protect your Astro application using Middleware.
- [Locals]({{SITE_URL}}/docs/reference/astro/locals): Learn how to authenticate your Astro application with Clerk using locals.
- [Clerk Astro SDK]({{SITE_URL}}/docs/reference/astro/overview): The Clerk Astro SDK gives you access to prebuilt components, stores, and helpers to make user authentication easier.
- [Use Clerk with Astro and React]({{SITE_URL}}/docs/reference/astro/react): Learn how to user Clerk inside an Astro app with React
- [`updateClerkOptions()`]({{SITE_URL}}/docs/reference/astro/update-clerk-options): The updateClerkOptions() function allows you to update Clerk's options at runtime.
- [`$organizationStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/organization-store): Clerk's $organizationStore store retrieves the currently active Organization.
- [`$authStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/auth-store): Clerk's $authStore nanostore provides a convenient way to access the current auth state and helper methods for managing the session.
- [`$sessionListStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/session-list-store): Clerk's $sessionList store retrieves a list of sessions that have been registered on the client device.
- [`$clerkStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/clerk-store): Clerk's $clerkStore nanostore provides a convenient way to access the Clerk object. This provides access to some methods that are not available in other stores.
- [`$signUpStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/sign-up-store): Clerk's $signUpStore nanostore provides a convenient way to access the SignUp object, which allows you to check the current state of a sign-up. This is also useful for creating a custom sign-up flow.
- [`$userStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/user-store): The $userStore store provides a convenient way to access current user data and helper methods for managing the active user.
- [`$signInStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/sign-in-store): Clerk's $signInStore nanostore provides a convenient way to access the SignIn object, which allows you to check the current state of a sign-in.
- [`$sessionStore`]({{SITE_URL}}/docs/reference/astro/client-side-helpers/session-store): Clerk's $sessionStore nanostore provides a convenient way to access the current user Session object, as well as helpers to set the session.
- [Clerk Go SDK]({{SITE_URL}}/docs/reference/go/overview): The Clerk Go SDK provides a powerful set of tools and utilities to seamlessly integrate authentication, user management, and Organization management into your Go application.
- [`auth()`]({{SITE_URL}}/docs/reference/tanstack-react-start/auth): The auth() helper retrieves the authentication state allowing you to protect your API routes or gather relevant data.
- [`clerkMiddleware()`]({{SITE_URL}}/docs/reference/tanstack-react-start/clerk-middleware): The clerkMiddleware() helper integrates Clerk authentication into your TanStack Start application through middleware.
- [Clerk TanStack React Start SDK]({{SITE_URL}}/docs/reference/tanstack-react-start/overview): The Clerk TanStack React Start SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [`getAuth()`]({{SITE_URL}}/docs/reference/react-router/get-auth): Access and manage the current user's authentication state in your React application with Clerk's getAuth() helper.
- [`clerkMiddleware()` | React Router]({{SITE_URL}}/docs/reference/react-router/clerk-middleware): The clerkMiddleware() function allows you to protect your React Router application using middleware.
- [Clerk React Router SDK]({{SITE_URL}}/docs/reference/react-router/overview): The Clerk React Router SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [`rootAuthLoader()`]({{SITE_URL}}/docs/reference/react-router/root-auth-loader): The rootAuthLoader() function configures Clerk to handle authentication state for React Router routes.
- [`getAuth()`]({{SITE_URL}}/docs/reference/fastify/get-auth): The getAuth() helper retrieves the current user's authentication state from the request object.
- [Clerk Fastify SDK]({{SITE_URL}}/docs/reference/fastify/overview): The Clerk Fastify SDK provides a powerful set of tools and utilities to seamlessly integrate authentication, user management, and Organization management into your Fastify application.
- [`clerkPlugin()`]({{SITE_URL}}/docs/reference/fastify/clerk-plugin): The clerkPlugin() function is a Fastify plugin that integrates Clerk's authentication into your application.
- [`requireAuth()`]({{SITE_URL}}/docs/reference/express/require-auth): The requireAuth() middleware protects your routes by redirecting unauthenticated users to the homepage.
- [`getAuth()`]({{SITE_URL}}/docs/reference/express/get-auth): The getAuth() helper retrieves authentication state from the request object.
- [`clerkMiddleware()`]({{SITE_URL}}/docs/reference/express/clerk-middleware): The clerkMiddleware() function checks the request's cookies and headers for a session JWT and if found, attaches the Auth object to the request object under the auth key.
- [Clerk Express SDK]({{SITE_URL}}/docs/reference/express/overview): The Clerk Express SDK provides a powerful set of tools and utilities to seamlessly integrate authentication, user management, and Organization management into your Express application.
- [SwiftUI previews]({{SITE_URL}}/docs/reference/ios/swiftui-previews): Use Clerk.preview() and ClerkEnvironment.json to render iOS previews with realistic Clerk configuration.
- [Watch Connectivity]({{SITE_URL}}/docs/reference/ios/watch-connectivity): Sync Clerk auth state between an iOS app and its companion watchOS app.
- [Configure passkeys for Android]({{SITE_URL}}/docs/reference/android/passkeys): Learn how to configure passkeys for your Android application.
- [Clerk Expo SDK]({{SITE_URL}}/docs/reference/expo/overview): The Clerk Expo SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [Configure passkeys for Expo]({{SITE_URL}}/docs/reference/expo/passkeys): Learn how to configure passkeys for your Expo application.
- [`<AuthView />` component]({{SITE_URL}}/docs/reference/expo/native-components/auth-view): A native authentication component that provides complete sign-in and sign-up flows for iOS and Android.
- [Theming Expo native components]({{SITE_URL}}/docs/reference/expo/native-components/theming): Customize the appearance of Clerk's native iOS and Android components with a JSON theme file.
- [Expo Native Components (beta)]({{SITE_URL}}/docs/reference/expo/native-components/overview): Pre-built native authentication and user management components for iOS and Android.
- [`<UserButton />`]({{SITE_URL}}/docs/reference/expo/native-components/user-button): A native avatar button component that displays the user's profile image and opens a profile management interface.
- [`<UserProfileView />` component]({{SITE_URL}}/docs/reference/expo/native-components/user-profile-view): A native profile management component providing complete account settings for iOS and Android.
- [`useSignInWithApple()`]({{SITE_URL}}/docs/reference/expo/native-hooks/use-sign-in-with-apple): Clerk's useSignInWithApple() hook provides native Sign in with Apple functionality for iOS devices.
- [useOAuth() (deprecated)]({{SITE_URL}}/docs/reference/expo/native-hooks/use-oauth): Clerk's useOAuth() hook is used to create a new OAuth flow.
- [`useSignInWithGoogle()`]({{SITE_URL}}/docs/reference/expo/native-hooks/use-sign-in-with-google): Clerk's useSignInWithGoogle() hook provides native Sign in with Google functionality for iOS and Android devices.
- [`useLocalCredentials()`]({{SITE_URL}}/docs/reference/expo/native-hooks/use-local-credentials): Clerk's useLocalCredentials() hook enables you to store and access a user's password credentials on their device.
- [useSSO()]({{SITE_URL}}/docs/reference/expo/native-hooks/use-sso): Clerk's useSSO() hook is used to create a new SSO flow.
- [`createClerkClient()`]({{SITE_URL}}/docs/reference/chrome-extension/create-clerk-client): createClerkClient() allows Chrome Extension developers to initialize Clerk in popups, side panels, and background service workers without React.
- [Clerk Chrome Extension SDK]({{SITE_URL}}/docs/reference/chrome-extension/overview): The Clerk Chrome Extension SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [Clerk JavaScript SDK]({{SITE_URL}}/docs/reference/javascript/overview): The Clerk JavaScript SDK is Clerk's foundational library for building user management and authentication.
- [Clerk React SDK]({{SITE_URL}}/docs/reference/react/overview): The Clerk React SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [API Reference]({{SITE_URL}}/docs/reference/api/overview): Access Clerk's frontend and backend API reference documentation.
- [`clerkClient`]({{SITE_URL}}/docs/reference/backend/overview): Use clerkClient to interact with Clerk's Backend API resources.
- [`authenticateRequest()`]({{SITE_URL}}/docs/reference/backend/authenticate-request): Use the authenticateRequest() method to verify a token passed from the frontend.
- [`verifyToken()`]({{SITE_URL}}/docs/reference/backend/verify-token): Use the verifyToken() method to verify a token signature.
- [`verifyWebhook()`]({{SITE_URL}}/docs/reference/backend/verify-webhook): Use the verifyWebhook() method to verify a webhook signature.
- [`createTestingToken()`]({{SITE_URL}}/docs/reference/backend/testing-tokens/create-testing-token): Use the createTestingToken() method to create a testing token for the instance.
- [`createSignInToken()`]({{SITE_URL}}/docs/reference/backend/sign-in-tokens/create-sign-in-token): Use the createSignInToken() method to create a new sign-in token for a given user.
- [`revokeSignInToken()`]({{SITE_URL}}/docs/reference/backend/sign-in-tokens/revoke-sign-in-token): Use the revokeSignInToken() method to revoke a pending sign-in token.
- [`getSessionList()`]({{SITE_URL}}/docs/reference/backend/sessions/get-session-list): Use the getSessionList() method to retrieve a list of sessions.
- [`getSession()`]({{SITE_URL}}/docs/reference/backend/sessions/get-session): Use the getSession() method to retrieve a single session by its ID.
- [`getToken()`]({{SITE_URL}}/docs/reference/backend/sessions/get-token): Use the getToken() method to retrieve a token for a JWT template that is defined in the Clerk Dashboard.
- [`revokeSession()`]({{SITE_URL}}/docs/reference/backend/sessions/revoke-session): Use the revokeSession() method to revoke a session given its ID.
- [`verifySession()` (deprecated)]({{SITE_URL}}/docs/reference/backend/sessions/verify-session): Use the verifySession() method to verify whether a session with a given ID corresponds to the provided session token.
- [`createSamlConnection()`]({{SITE_URL}}/docs/reference/backend/saml-connections/create-saml-connection): Use the createSamlConnection() method to create a SAML connection.
- [`deleteSamlConnection()`]({{SITE_URL}}/docs/reference/backend/saml-connections/delete-saml-connection): Use the deleteSamlConnection() method to delete a SAML connection.
- [`getSamlConnectionList()`]({{SITE_URL}}/docs/reference/backend/saml-connections/get-saml-connection-list): Use the getSamlConnectionList() method to retrieve the list of SAML connections for an instance.
- [`getSamlConnection()`]({{SITE_URL}}/docs/reference/backend/saml-connections/get-saml-connection): Use the getSamlConnection() method to retrieve a SAML connection.
- [`updateSamlConnection()`]({{SITE_URL}}/docs/reference/backend/saml-connections/update-saml-connection): Use the updateSamlConnection() method to update a SAML connection.
- [`createRedirectUrl()`]({{SITE_URL}}/docs/reference/backend/redirect-urls/create-redirect-url): Use the createRedirectUrl() method to create a redirect URL.
- [`deleteRedirectUrl()`]({{SITE_URL}}/docs/reference/backend/redirect-urls/delete-redirect-url): Use the deleteRedirectUrl() method to delete a redirect URL.
- [`getRedirectUrlList()`]({{SITE_URL}}/docs/reference/backend/redirect-urls/get-redirect-url-list): Use the getRedirectUrlList() method to retrieve a list of white-listed redirect URLs.
- [`getRedirectUrl()`]({{SITE_URL}}/docs/reference/backend/redirect-urls/get-redirect-url): Use the getRedirectUrl() method to retrieve a single redirect URL by its ID.
- [`createPhoneNumber()`]({{SITE_URL}}/docs/reference/backend/phone-numbers/create-phone-number): Use the createPhoneNumber() method to create a phone number for the specified user.
- [`deletePhoneNumber()`]({{SITE_URL}}/docs/reference/backend/phone-numbers/delete-phone-number): Use the deletePhoneNumber() method to delete a phone number.
- [`getPhoneNumber()`]({{SITE_URL}}/docs/reference/backend/phone-numbers/get-phone-number): Use the getPhoneNumber() method to retrieve a single phone number by its ID.
- [`updatePhoneNumber()`]({{SITE_URL}}/docs/reference/backend/phone-numbers/update-phone-number): Use the updatePhoneNumber() method to update a phone number.
- [`update()`]({{SITE_URL}}/docs/reference/backend/machines/update): Use the update() method to update a machine.
- [`rotateSecretKey()`]({{SITE_URL}}/docs/reference/backend/machines/rotate-secret-key): Use the rotateSecretKey() method to rotate a machine's secret key.
- [`list()`]({{SITE_URL}}/docs/reference/backend/machines/list): Use the list() method to get a list of machines for your application.
- [`get()`]({{SITE_URL}}/docs/reference/backend/machines/get): Use the get() method to retrieve a machine.
- [`getSecretKey()`]({{SITE_URL}}/docs/reference/backend/machines/get-secret-key): Use the getSecretKey() method to retrieve a machine secret key.
- [`delete()`]({{SITE_URL}}/docs/reference/backend/machines/delete): Use the delete() method to delete a machine.
- [`deleteScope()`]({{SITE_URL}}/docs/reference/backend/machines/delete-scope): Use the deleteScope() method to delete a machine scope.
- [`create()`]({{SITE_URL}}/docs/reference/backend/machines/create): Use the create() method to create a machine.
- [`createScope()`]({{SITE_URL}}/docs/reference/backend/machines/create-scope): Use the createScope() method to create a machine scope.
- [`update()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/update): Use the update() method to update an OAuth application.
- [`rotateSecret()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/rotate-secret): Use the rotateSecret() method to rotate the OAuth application's client secret.
- [`list()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/list): Use the list() method to retrieve a list of OAuth applications for an instance.
- [`get()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/get): Use the get() method to retrieve an OAuth application.
- [`delete()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/delete): Use the delete() method to delete an OAuth application.
- [`create()`]({{SITE_URL}}/docs/reference/backend/oauth-applications/create): Use the create() method to create an OAuth application.
- [`createOrganizationInvitationBulk()`]({{SITE_URL}}/docs/reference/backend/organization/create-organization-invitation-bulk): Use the createOrganizationInvitationBulk() method to create multiple invitations for new users to join an Organization.
- [`createOrganizationInvitation()`]({{SITE_URL}}/docs/reference/backend/organization/create-organization-invitation): Use the createOrganizationInvitation() method to create an invitation for new users to join an Organization.
- [`createOrganizationMembership()`]({{SITE_URL}}/docs/reference/backend/organization/create-organization-membership): Use the createOrganizationMembership() method to create a membership to an Organization for a user directly (circumventing the need for an invitation).
- [`createOrganization()`]({{SITE_URL}}/docs/reference/backend/organization/create-organization): Use the createOrganization() method to create an Organization.
- [`deleteOrganizationLogo()`]({{SITE_URL}}/docs/reference/backend/organization/delete-organization-logo): Use the deleteOrganizationLogo() method to delete an Organization's logo.
- [`deleteOrganizationMembership()`]({{SITE_URL}}/docs/reference/backend/organization/delete-organization-membership): Use the deleteOrganizationMembership() method to remove a user from the specified Organization.
- [`deleteOrganization()`]({{SITE_URL}}/docs/reference/backend/organization/delete-organization): Use the deleteOrganization() method to delete an Organization.
- [`getOrganizationInvitationList()`]({{SITE_URL}}/docs/reference/backend/organization/get-organization-invitation-list): Use the getOrganizationInvitationList() method to retrieve a list of Organization invitations.
- [`getOrganizationInvitation()`]({{SITE_URL}}/docs/reference/backend/organization/get-organization-invitation): Use the getOrganizationInvitation() method to retrieve an Organization invitation.
- [`getOrganizationList()`]({{SITE_URL}}/docs/reference/backend/organization/get-organization-list): Use the getOrganizationList() method to retrieve a list of Organizations.
- [`getOrganizationMembershipList()`]({{SITE_URL}}/docs/reference/backend/organization/get-organization-membership-list): Use the getOrganizationMembershipList() method to retrieve a list of memberships for an Organization.
- [`updateOrganization()`]({{SITE_URL}}/docs/reference/backend/organization/update-organization): Use the updateOrganization() method to update an Organization's name.
- [`updateOrganizationMetadata()`]({{SITE_URL}}/docs/reference/backend/organization/update-organization-metadata): Use the updateOrganizationMetadata() method to update the metadata associated with a given Organization.
- [`updateOrganizationMembership()`]({{SITE_URL}}/docs/reference/backend/organization/update-organization-membership): Use the updateOrganizationMembership() method to update a user's Organization membership.
- [`updateOrganizationMembershipMetadata()`]({{SITE_URL}}/docs/reference/backend/organization/update-organization-membership-metadata): Use the updateOrganizationMembershipMetadata() method to update the metadata associated with a user's Organization membership.
- [`updateOrganizationLogo()`]({{SITE_URL}}/docs/reference/backend/organization/update-organization-logo): Use the updateOrganizationLogo() method to update an Organization's logo.
- [`revokeOrganizationInvitation()`]({{SITE_URL}}/docs/reference/backend/organization/revoke-organization-invitation): Use the revokeOrganizationInvitation() method to revoke an Organization invitation from a user for a specified Organization.
- [`getOrganization()`]({{SITE_URL}}/docs/reference/backend/organization/get-organization): Use the getOrganization() method to retrieve a single Organization.
- [`createToken()`]({{SITE_URL}}/docs/reference/backend/m2m-tokens/create-token): Use the createToken() method to create a M2M token.
- [`revokeToken()`]({{SITE_URL}}/docs/reference/backend/m2m-tokens/revoke-token): Use the revokeToken() method to revoke a M2M token.
- [`list()`]({{SITE_URL}}/docs/reference/backend/m2m-tokens/list): Use the list() method to get a list of M2M tokens for your a given machine.
- [`verify()`]({{SITE_URL}}/docs/reference/backend/m2m-tokens/verify): Use the verify() method to verify an M2M token.
- [`createInvitationBulk()`]({{SITE_URL}}/docs/reference/backend/invitations/create-invitation-bulk): Use the createInvitationBulk() method to create multiple invitations for the given email addresses, and send the invitation emails.
- [`createInvitation()`]({{SITE_URL}}/docs/reference/backend/invitations/create-invitation): Use the createInvitation() method to create a new invitation for the given email address, and send the invitation email.
- [`getInvitationList()`]({{SITE_URL}}/docs/reference/backend/invitations/get-invitation-list): Use the getInvitationList() method to retrieve a list of non-revoked invitations for your application.
- [`revokeInvitation()`]({{SITE_URL}}/docs/reference/backend/invitations/revoke-invitation): Use the revokeInvitation() method to revoke an invitation.
- [`createEmailAddress()`]({{SITE_URL}}/docs/reference/backend/email-addresses/create-email-address): Use the createEmailAddress() method to create an email address for the specified user.
- [`deleteEmailAddress()`]({{SITE_URL}}/docs/reference/backend/email-addresses/delete-email-address): Use the deleteEmailAddress() method to delete an email address.
- [`getEmailAddress()`]({{SITE_URL}}/docs/reference/backend/email-addresses/get-email-address): Use the getEmailAddress() method to retrieve a single email address by its ID.
- [`updateEmailAddress()`]({{SITE_URL}}/docs/reference/backend/email-addresses/update-email-address): Use the updateEmailAddress() method to update an email address.
- [`deleteDomain()`]({{SITE_URL}}/docs/reference/backend/domains/delete-domain): Use the deleteDomain() method to delete a satellite domain for the instance.
- [`getClientList()` (deprecated)]({{SITE_URL}}/docs/reference/backend/client/get-client-list): Retrieves the list of clients.
- [`getClient()`]({{SITE_URL}}/docs/reference/backend/client/get-client): Use the getClient() method to retrieve a single client by its ID.
- [`verifyClient()`]({{SITE_URL}}/docs/reference/backend/client/verify-client): Use the verifyClient() method to retrieve a client for a given session token, if the session is active.
- [`cancelSubscriptionItem()`]({{SITE_URL}}/docs/reference/backend/billing/cancel-subscription-item): Use the cancelSubscriptionItem() method to cancel a Subscription Item.
- [`getOrganizationBillingSubscription()`]({{SITE_URL}}/docs/reference/backend/billing/get-organization-billing-subscription): Use the getOrganizationBillingSubscription() method to retrieve an Organization's Billing Subscription.
- [`getPlanList()`]({{SITE_URL}}/docs/reference/backend/billing/get-plan-list): Use the getPlanList() method to retrieve a list of Billing Plans.
- [`getUserBillingSubscription()`]({{SITE_URL}}/docs/reference/backend/billing/get-user-billing-subscription): Use the getUserBillingSubscription() method to retrieve a user's Billing Subscription.
- [`getAllowlistIdentifierList()`]({{SITE_URL}}/docs/reference/backend/allowlist/get-allowlist-identifier-list): Use the getAllowlistIdentifierList() method to retrieve a list of allowlist identifiers.
- [`deleteAllowlistIdentifier()`]({{SITE_URL}}/docs/reference/backend/allowlist/delete-allowlist-identifier): Use the deleteAllowlistIdentifier() method to delete an allowlist identifier.
- [`createAllowlistIdentifier()`]({{SITE_URL}}/docs/reference/backend/allowlist/create-allowlist-identifier): Use the createAllowlistIdentifier() method to add a new identifier to the allowlist.
- [`delete()`]({{SITE_URL}}/docs/reference/backend/api-keys/delete): Use the delete() method to delete an API key.
- [`create()`]({{SITE_URL}}/docs/reference/backend/api-keys/create): Use the create() method to create an API key.
- [`verify()`]({{SITE_URL}}/docs/reference/backend/api-keys/verify): Use the verify() method to verify an API key secret.
- [`update()`]({{SITE_URL}}/docs/reference/backend/api-keys/update): Use the update() method to update an API key.
- [`revoke()`]({{SITE_URL}}/docs/reference/backend/api-keys/revoke): Use the revoke() method to revoke an API key.
- [`list()`]({{SITE_URL}}/docs/reference/backend/api-keys/list): Use the list() method to list API keys.
- [`get()`]({{SITE_URL}}/docs/reference/backend/api-keys/get): Use the get() method to retrieve an API key.
- [`reject()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/reject): Use the reject() method to reject a waitlist entry by ID.
- [`list()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/list): Use the list() method to retrieve a list of waitlist entries.
- [`createBulk()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/create-bulk): Use the createBulk() method to bulk create waitlist entries for the given email addresses.
- [`create()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/create): Use the create() method to create a waitlist entry for the given email address.
- [`delete()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/delete): Use the delete() method to delete a pending waitlist entry by ID.
- [`invite()`]({{SITE_URL}}/docs/reference/backend/waitlist-entries/invite): Use the invite() method to invite a waitlist entry by ID.
- [`banUser()`]({{SITE_URL}}/docs/reference/backend/user/ban-user): Use the banUser() method to mark a given user as banned.
- [`createUser()`]({{SITE_URL}}/docs/reference/backend/user/create-user): Use the createUser() method to create a user.
- [`deleteUserBackupCodes()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-backup-codes): Use the deleteUserBackupCodes() method to delete all of a user's backup codes.
- [`deleteUserExternalAccount()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-external-account): Use the deleteUserExternalAccount() method to delete a user's external account by ID.
- [`deleteUserPasskey()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-passkey): Use the deleteUserPasskey() method to delete the passkey identification for a given user.
- [`deleteUserProfileImage()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-profile-image): Use the deleteUserProfileImage() method to delete a user's profile image.
- [`deleteUserTOTP()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-totp): Use the deleteUserTOTP() method to delete all of a user's TOTPs.
- [`deleteUserWeb3Wallet()`]({{SITE_URL}}/docs/reference/backend/user/delete-user-web3-wallet): Use the deleteUserWeb3Wallet() method to delete the Web3 wallet identification for a given user.
- [`deleteUser()`]({{SITE_URL}}/docs/reference/backend/user/delete-user): Use the deleteUser() method to delete a user.
- [`disableUserMFA()`]({{SITE_URL}}/docs/reference/backend/user/disable-user-mfa): Use the disableUserMFA() method to disable all of a user's MFA methods at once.
- [`getCount()`]({{SITE_URL}}/docs/reference/backend/user/get-count): Use the getCount() method to retrieve the total number of users.
- [`getOrganizationInvitationList()`]({{SITE_URL}}/docs/reference/backend/user/get-organization-invitation-list): Use the getOrganizationInvitationList() method to retrieve a list of Organization invitations for a given user.
- [`getOrganizationMembershipList()`]({{SITE_URL}}/docs/reference/backend/user/get-organization-membership-list): Use the getOrganizationMembershipList() method to retrieve a list of Organization memberships for a given user.
- [`getUserList()`]({{SITE_URL}}/docs/reference/backend/user/get-user-list): Use the getUserList() method to retrieve a list of users.
- [getUserOauthAccessToken()]({{SITE_URL}}/docs/reference/backend/user/get-user-oauth-access-token): Use the getUserOauthAccessToken() method to retrieve the corresponding OAuth access token for a user.
- [`getUser()`]({{SITE_URL}}/docs/reference/backend/user/get-user): Use the getUser() method to retrieve a single user by their ID.
- [`lockUser()`]({{SITE_URL}}/docs/reference/backend/user/lock-user): Use the lockUser() method to mark a user as locked, which means they are not allowed to sign in again until the lock expires.
- [`unbanUser()`]({{SITE_URL}}/docs/reference/backend/user/unban-user): Use the unbanUser() method to remove the ban mark from a user.
- [`unlockUser()`]({{SITE_URL}}/docs/reference/backend/user/unlock-user): Use the unlockUser() method to remove a sign-in lock from a user.
- [`updateUserMetadata()`]({{SITE_URL}}/docs/reference/backend/user/update-user-metadata): Use the updateUserMetadata() method to update the metadata associated with the specified user.
- [`updateUserProfileImage()`]({{SITE_URL}}/docs/reference/backend/user/update-user-profile-image): Use the updateUserProfileImage() method to update a user's profile image.
- [`updateUser()`]({{SITE_URL}}/docs/reference/backend/user/update-user): Use the updateUser() method to update a user.
- [`verifyPassword()`]({{SITE_URL}}/docs/reference/backend/user/verify-password): Use the verifyPassword() method to check that the user's password matches the supplied input. Useful for custom auth flows and re-verification.
- [`verifyTOTP()`]({{SITE_URL}}/docs/reference/backend/user/verify-totp): Use the verifyTOTP() method to verify a TOTP or backup code for a user.
- [`CommercePlan`]({{SITE_URL}}/docs/reference/backend/types/commerce-plan): The Backend CommercePlan object holds information about a Plan of your application.
- [`CommerceSubscriptionItem`]({{SITE_URL}}/docs/reference/backend/types/commerce-subscription-item): The Backend CommerceSubscriptionItem object holds information about a Subscription Item of your application.
- [`CommerceSubscription`]({{SITE_URL}}/docs/reference/backend/types/commerce-subscription): The Backend CommerceSubscription object holds information about a Subscription of your application.
- [`Feature`]({{SITE_URL}}/docs/reference/backend/types/feature): The Feature type represents a Feature that a Plan can offer.
- [`PaginatedResourceResponse`]({{SITE_URL}}/docs/reference/backend/types/paginated-resource-response): An interface that describes the response of a method that returns a paginated list of resources.
- [Auth object]({{SITE_URL}}/docs/reference/backend/types/auth-object): The Auth object contains information about the current user's session.
- [The Backend `AllowlistIdentifier` object]({{SITE_URL}}/docs/reference/backend/types/backend-allowlist-identifier): The Backend AllowlistIdentifier object holds information about a AllowlistIdentifier of your application. However, the Backend AllowlistIdentifier object is different from the AllowlistIdentifier object in that it is used in the Backend API.
- [The Backend `APIKey` object]({{SITE_URL}}/docs/reference/backend/types/backend-api-key): The Backend APIKey object holds information about an API key of your application.
- [The Backend `Client` object]({{SITE_URL}}/docs/reference/backend/types/backend-client): The Backend Client object holds information about the authenticated sessions in the current device. However, the Backend Client object is different from the Client object in that it is used in the Backend API.
- [The Backend `EmailAddress` object]({{SITE_URL}}/docs/reference/backend/types/backend-email-address): The Backend EmailAddress object is a model around an email address.
- [The Backend `EnterpriseAccountConnection` object]({{SITE_URL}}/docs/reference/backend/types/backend-enterprise-account-connection): The Backend EnterpriseAccountConnection object represents an enterprise SSO connection associated with an enterprise account.
- [The Backend `EnterpriseAccount` object]({{SITE_URL}}/docs/reference/backend/types/backend-enterprise-account): The Backend EnterpriseAccount object represents an identification obtained via enterprise SSO (SAML or OIDC).
- [The Backend `ExternalAccount` object]({{SITE_URL}}/docs/reference/backend/types/backend-external-account): The Backend ExternalAccount object is a model around an identification obtained by an external provider (e.g. a social provider such as Google).
- [The Backend `IdentificationLink` object]({{SITE_URL}}/docs/reference/backend/types/backend-identification-link): Contains information about any identifications that might be linked to the email address.
- [The Backend `Invitation` object]({{SITE_URL}}/docs/reference/backend/types/backend-invitation): The Backend Invitation object represents an invitation to join your application.
- [The Backend `OauthAccessToken` object]({{SITE_URL}}/docs/reference/backend/types/backend-oauth-access-token): The Backend OAuthAccessToken object describes an OAuth Access Token.
- [The Backend `OAuthApplication` object]({{SITE_URL}}/docs/reference/backend/types/backend-oauth-application): The Backend OAuthApplication object describes an OAuth Application.
- [The Backend `OrganizationInvitation` object]({{SITE_URL}}/docs/reference/backend/types/backend-organization-invitation): The Backend OrganizationInvitation object is the model around an Organization invitation.
- [The Backend `OrganizationMembership` object]({{SITE_URL}}/docs/reference/backend/types/backend-organization-membership): The Backend OrganizationMembership object is the model around an Organization membership entity and describes the relationship between users and Organizations.
- [The Backend `Organization` object]({{SITE_URL}}/docs/reference/backend/types/backend-organization): The Backend Organization object holds information about an Organization, as well as methods for managing it. However, the it is different from the Organization object in that it is used in the Backend API and is not directly accessible from the Frontend API.
- [The Backend `PhoneNumber` object]({{SITE_URL}}/docs/reference/backend/types/backend-phone-number): The Backend PhoneNumber object describes a phone number.
- [The Backend `RedirectUrl` object]({{SITE_URL}}/docs/reference/backend/types/backend-redirect-url): The Backend RedirectUrl object represents a redirect URL in your application. This object is used in the Backend API.
- [The Backend `SamlConnection` object]({{SITE_URL}}/docs/reference/backend/types/backend-saml-connection): The Backend SamlConnection object holds information about a SAML connection for an Organization.
- [The Backend `SessionActivity` object]({{SITE_URL}}/docs/reference/backend/types/backend-session-activity): The Backend SessionActivity object models the activity of a user session, capturing details such as the device type, browser information, and geographical location.
- [The Backend `Session` object]({{SITE_URL}}/docs/reference/backend/types/backend-session): The Backend Session object holds information about a Session of your application. However, the Backend Session object is different from the Session object in that it is used in the Backend API.
- [The Backend `User` object]({{SITE_URL}}/docs/reference/backend/types/backend-user): The Backend User object holds information about a user of your application. However, the Backend User object is different from the User object in that it is used in the Backend API.
- [The Backend `Verification` object]({{SITE_URL}}/docs/reference/backend/types/backend-verification): The Backend Verification object describes the state of the verification process of a sign-in or sign-up attempt.
- [The Backend `WaitlistEntry` object]({{SITE_URL}}/docs/reference/backend/types/backend-waitlist-entry): The Backend WaitlistEntry object is the model around a waitlist entry.
- [The Backend `Web3Wallet` object]({{SITE_URL}}/docs/reference/backend/types/backend-web3-wallet): The Backend Web3Wallet object describes a Web3 wallet address.
- [Component Changelog]({{SITE_URL}}/docs/reference/components/changelog): Keep track of the changes to Clerk's components.
- [Component Versioning]({{SITE_URL}}/docs/reference/components/versioning): Learn how Clerk versions its components, and how to specify a specific version if necessary.
- [Use Clerk with Next.js 12 and older]({{SITE_URL}}/docs/reference/nextjs/usage-with-older-versions): Learn how to use Clerk with older versions of Next.js.
- [clerkMiddleware() | Next.js]({{SITE_URL}}/docs/reference/nextjs/clerk-middleware): The clerkMiddleware() function allows you to protect your Next.js application using Middleware.
- [Clerk Next.js SDK]({{SITE_URL}}/docs/reference/nextjs/overview): The Clerk Next.js SDK gives you access to prebuilt components, React hooks, and helpers to make user authentication easier.
- [`auth()`]({{SITE_URL}}/docs/reference/nextjs/app-router/auth): Access minimal authentication data for managing sessions and data fetching.
- [`currentUser()`]({{SITE_URL}}/docs/reference/nextjs/app-router/current-user): Use the currentUser() helper to access information about your user inside of your Server Components, Route Handlers, and Server Actions.
- [Server Actions]({{SITE_URL}}/docs/reference/nextjs/app-router/server-actions): Learn how to use Clerk with Server Actions.
- [Route Handlers]({{SITE_URL}}/docs/reference/nextjs/app-router/route-handlers): Learn how to use Clerk with your Route Handlers.
- [`buildClerkProps`]({{SITE_URL}}/docs/reference/nextjs/pages-router/build-clerk-props): Clerk uses buildClerkProps to inform the client-side helpers of the authentication state of the user. This function is used SSR in the getServerSideProps function of your Next.js application.
- [`getAuth()`]({{SITE_URL}}/docs/reference/nextjs/pages-router/get-auth): The getAuth() helper retrieves authentication state from the request object.
- [Clerk: auth() was called but Clerk can't detect usage of clerkMiddleware()]({{SITE_URL}}/docs/reference/nextjs/errors/auth-was-called): Learn how to handle auth() was called but Clerk can't detect usage of clerkMiddleware() when getting 404 errors in Next.js.
- [Cookies]({{SITE_URL}}/docs/guides/how-clerk-works/cookies): Learn how cookies enable secure authentication and manage browser-server interactions.
- [Multi-tenant architecture]({{SITE_URL}}/docs/guides/how-clerk-works/multi-tenant-architecture): This guide outlines a number of the common architecture scenarios for building B2B, B2C, and Platform applications with Clerk, their characteristics, and limitations.
- [How Clerk works]({{SITE_URL}}/docs/guides/how-clerk-works/overview): Learn how Clerk is architected and how it works under the hood.
- [Routing in Clerk]({{SITE_URL}}/docs/guides/how-clerk-works/routing): Learn how Clerk handles routing in your application.
- [Rate limits]({{SITE_URL}}/docs/guides/how-clerk-works/system-limits): Learn about rate limiting on the Clerk APIs.
- [Tokens and signatures]({{SITE_URL}}/docs/guides/how-clerk-works/tokens-and-signatures): Learn about JWTs, digital signatures, and how Clerk uses them to securely authenticate users.
- [Clerk Telemetry]({{SITE_URL}}/docs/guides/how-clerk-works/security/clerk-telemetry): Clerk collects telemetry data from its SDKs about general product and feature usage.
- [Vulnerability disclosure policy]({{SITE_URL}}/docs/guides/how-clerk-works/security/vulnerability-disclosure-policy): Clerk's vulnerability disclosure policy.
- [Configure Organizations]({{SITE_URL}}/docs/guides/organizations/configure): Learn how to configure global Organization settings in the Clerk Dashboard, including pricing, membership limits, and optional features.
- [Create and manage Organizations]({{SITE_URL}}/docs/guides/organizations/create-and-manage): Learn how to create and manage individual Organizations in the Clerk Dashboard and in your application.
- [Organization metadata]({{SITE_URL}}/docs/guides/organizations/metadata): Learn how to add custom metadata to your B2B authentication flows to store additional information in the org object for advanced user segmentation, analytics, and B2B workflows.
- [Use Organization slugs in URLs]({{SITE_URL}}/docs/guides/organizations/org-slugs-in-urls): Learn how to use Organization slugs in your application URLs to build tenant-specific authentication flows. Enable seamless switching between active Organizations (one-to-many or many-to-many) with Clerk's secure and scalable multi-tenant authentication suite.
- [Organizations]({{SITE_URL}}/docs/guides/organizations/overview): Learn what Clerk Organizations are, how they work, and how to build secure multi-tenant B2B applications with team workspaces, Role-Based Access Control, and streamlined enrollment.
- [Invite users to your Organization]({{SITE_URL}}/docs/guides/organizations/add-members/invitations): Send, manage, and track user invitations within your multi-tenant SaaS using Clerk Organizations.
- [Organization-level Enterprise SSO]({{SITE_URL}}/docs/guides/organizations/add-members/sso): Integrate as many Enterprise SSO methods within Clerk Organizations. Enable SAML SSO, OAuth/OIDC, and other secure MFA/single sign-on options for B2B SaaS apps.
- [Verified Domains]({{SITE_URL}}/docs/guides/organizations/add-members/verified-domains): Build Organization-specific or tenant-isolated authentication flows that only authorized users with matching domains can join, using Verified Domains within Clerk Organizations.
- [Roles and Permissions]({{SITE_URL}}/docs/guides/organizations/control-access/roles-and-permissions): Implement Role-Based Access Control (RBAC) in your application. Set custom Roles, assign privileges, and control access to resources using Clerk Organizations.
- [Role Sets]({{SITE_URL}}/docs/guides/organizations/control-access/role-sets): Control which Roles are available to each Organization using Role Sets, the foundational building block for organization-level access control.
- [Check Roles and Permissions with Authorization Checks]({{SITE_URL}}/docs/guides/organizations/control-access/check-access): Limit access to content or entire routes based on a user's Organization Role or Permissions.
- [Clerk Skills]({{SITE_URL}}/docs/guides/ai/skills): Install Clerk Skills to enhance AI coding agents with authentication expertise.
- [Using Clerk with AI]({{SITE_URL}}/docs/guides/ai/overview): Learn how to integrate Clerk authentication with AI-powered applications and development tools.
- [Connect MCP-compatible clients to your MCP server]({{SITE_URL}}/docs/guides/ai/mcp/connect-mcp-client): Learn how to connect MCP-compatible clients, like Cursor, to your MCP server
- [Use Clerk's MCP server]({{SITE_URL}}/docs/guides/ai/mcp/clerk-mcp-server): Connect AI agents to Clerk's MCP server to access SDK snippets and implementation patterns.
- [Getting started with the Account Portal]({{SITE_URL}}/docs/guides/account-portal/getting-started): The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
- [Disabling the Account Portal]({{SITE_URL}}/docs/guides/account-portal/disable-account-portal): Learn how to disable the Account Portal.
- [Linking to Account Portal pages]({{SITE_URL}}/docs/guides/account-portal/direct-links): Learn how to share direct links to your Account Portal pages, and how to set up fallback redirects.
- [Account Portal overview]({{SITE_URL}}/docs/guides/account-portal/overview): The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
- [Custom Plans and prices]({{SITE_URL}}/docs/guides/billing/custom-plans): Transition Subscriptions between Plans and create custom pricing for your customers
- [Default Plans]({{SITE_URL}}/docs/guides/billing/default-plans): Learn more about default Plans and how they work in Clerk Billing
- [Free trials]({{SITE_URL}}/docs/guides/billing/free-trials): Let users try paid Features before subscribing
- [Clerk Billing]({{SITE_URL}}/docs/guides/billing/overview): Clerk Billing is a feature that allows you to create and manage Plans and Features for your application.
- [Plans with seat limits]({{SITE_URL}}/docs/guides/billing/seat-limit-plans): Restrict organization membership by Plan tier using seat-based limits
- [Tasks after sign-up/sign-in]({{SITE_URL}}/docs/guides/configure/session-tasks): Learn how to configure your application to require users to complete specific tasks after signing up or signing in.
- [Sign-up and sign-in options]({{SITE_URL}}/docs/guides/configure/auth-strategies/sign-up-sign-in-options): Clerk provides various options for configuring a sign-up and sign-in flow.
- [Account linking]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/account-linking): Learn how Clerk handles account linking during Enterprise SSO.
- [Enterprise SSO authentication flows]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/authentication-flows): Learn about the Enterprise SSO authentication flows.
- [Custom Attribute Mapping]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/custom-attribute-mapping): Learn how to sync custom attributes from your Identity Provider to Clerk's public metadata, shared across SSO and Directory Sync connections.
- [Directory Sync (SCIM)]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/directory-sync): Learn how to use Directory Sync (SCIM) to automatically provision and deprovision users, sync custom attributes, and map IdP groups to Clerk roles.
- [Just-in-Time (JIT) Provisioning during SAML SSO]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/jit-provisioning): Learn about Clerk's support for Just-in-Time (JIT) Provisioning during SAML SSO.
- [Enterprise Single Sign-On (SSO)]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/overview): Clerk provides Enterprise SSO to authenticate users via federated Identity Providers such such as Azure AD, Okta, Google Workspace and more.
- [Add a custom OpenID Connect (OIDC) Provider as an enterprise connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/oidc/custom-provider): Learn how to integrate a custom OIDC provider with Clerk for Enterprise SSO.
- [Add Google as an EASIE connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/easie/google): Learn how to allow users to sign up and sign in to your Clerk app with their Google account using EASIE SSO.
- [Add Microsoft as an EASIE connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/easie/microsoft): Learn how to allow users to sign up and sign in to your Clerk app with their Microsoft account using EASIE SSO.
- [Add Google Workspace as a SAML connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/saml/google): Learn how to integrate Google Workspace with Clerk using SAML SSO.
- [Add Okta Workforce as a SAML connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/saml/okta): Learn how to integrate Okta Workforce with Clerk using SAML SSO.
- [Add a custom Identity Provider (IdP) as a SAML connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/saml/custom-provider): Learn how to integrate an Identity Provider (IdP) with Clerk using SAML SSO.
- [Add Microsoft Entra ID as a SAML connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/enterprise-connections/saml/azure): Learn how to allow users to sign up and sign in to your Clerk app with their Microsoft account using SAML SSO.
- [How Clerk implements OAuth]({{SITE_URL}}/docs/guides/configure/auth-strategies/oauth/how-clerk-implements-oauth): Learn how to configure and secure OAuth flows with Clerk, including dynamic client registration, consent screens, PKCE, public clients, and scopes.
- [OAuth and OIDC overview]({{SITE_URL}}/docs/guides/configure/auth-strategies/oauth/overview): Learn what OAuth and OpenID Connect (OIDC) are, why they're used, and how the different OAuth flows work.
- [Use OAuth for Single Sign-On (SSO)]({{SITE_URL}}/docs/guides/configure/auth-strategies/oauth/single-sign-on): Learn how to implement single sign-on with OAuth & OpenID Connect in your Clerk application or when signing into a third-party app.
- [Use OAuth for scoped access]({{SITE_URL}}/docs/guides/configure/auth-strategies/oauth/scoped-access): Learn how to use OAuth with Clerk to grant granular permissions and manage access securely.
- [Verify OAuth tokens with Clerk]({{SITE_URL}}/docs/guides/configure/auth-strategies/oauth/verify-oauth-tokens): Learn how to verify OAuth tokens in your applications.
- [Base]({{SITE_URL}}/docs/guides/configure/auth-strategies/web3/base): Learn how to set up Web3 authentication with Base.
- [Coinbase Wallet]({{SITE_URL}}/docs/guides/configure/auth-strategies/web3/coinbase-wallet): Learn how to set up Web3 authentication with Coinbase Wallet.
- [MetaMask]({{SITE_URL}}/docs/guides/configure/auth-strategies/web3/metamask): Learn how to set up Web3 authentication with MetaMask.
- [OKX Wallet]({{SITE_URL}}/docs/guides/configure/auth-strategies/web3/okx-wallet): Learn how to set up Web3 authentication with OKX Wallet.
- [Solana]({{SITE_URL}}/docs/guides/configure/auth-strategies/web3/solana): Learn how to set up Web3 authentication with Solana.
- [Add Slack as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/slack): Learn how to allow users to sign up and sign in to your Clerk app with their Slack account using OAuth.
- [Add Spotify as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/spotify): Learn how to allow users to sign up and sign in to your Clerk app with their Spotify account using OAuth.
- [Twitter v1 (deprecated)]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/twitter): Learn how to set up social connection with Twitter v1.
- [Add Twitch as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/twitch): Learn how to allow users to sign up and sign in to your Clerk app with their Twitch account with OAuth.
- [Add TikTok as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/tiktok): Learn how to allow users to sign up and sign in to your Clerk app with their TikTok account using OAuth.
- [Add Vercel as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/vercel): Learn how to allow users to sign up and sign in to your Clerk app with their Vercel account using OAuth.
- [Add GitHub as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/github): Learn how to allow users to sign up and sign in to your Clerk app with their GitHub account using OAuth.
- [Add Xero as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/xero): Learn how to allow users to sign up and sign in to your Clerk app with their Xero account using OAuth.
- [Add GitLab as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/gitlab): Learn how to allow users to sign up and sign in to your Clerk app with their GitLab account using OAuth.
- [Add X/Twitter v2 as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/x-twitter): Learn how to allow users to sign up and sign in to your Clerk app with their X/Twitter account using OAuth.
- [Add Atlassian as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/atlassian): Learn how to allow users to sign up and sign in to your Clerk app with their Atlassian account using OAuth.
- [Add Google as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/google): Learn how to allow users to sign up and sign in to your Clerk app with their Google account using OAuth.
- [Add HubSpot as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/hubspot): Learn how to allow users to sign up and sign in to your Clerk app with their HubSpot account using OAuth.
- [Add Hugging Face as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/hugging-face): Learn how to allow users to sign up and sign in to your Clerk app with their Hugging Face account using OAuth.
- [Add LINE as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/line): Learn how to allow users to sign up and sign in to your Clerk app with their LINE account using OAuth.
- [Add Linear as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/linear): Learn how to allow users to sign up and sign in to your Clerk app with their Linear account using OAuth.
- [Add LinkedIn Open ID Connect (OIDC) as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/linkedin-oidc): Learn how to allow users to sign up and sign in to your Clerk app with their LinkedIn Open ID Connect (OIDC) account.
- [Add Microsoft Azure Entra ID as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/microsoft): Learn how to allow users to sign up and sign in to your Clerk app with their Microsoft account using OAuth.
- [Add Notion as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/notion): Learn how to allow users to sign up and sign in to your Clerk app with their Notion account using OAuth.
- [Add Facebook as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/facebook): Learn how to allow users to sign up and sign in to your Clerk app with their Facebook account using OAuth.
- [Add Bitbucket as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/bitbucket): Learn how to allow users to sign up and sign in to your Clerk app with their Bitbucket account with OAuth.
- [Add Box as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/box): Learn how to allow users to sign up and sign in to your Clerk app with their Box account using OAuth.
- [Add Coinbase as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/coinbase): Learn how to allow users to sign up and sign in to your Clerk app with their Coinbase account using OAuth.
- [Add a custom OAuth provider as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/custom-provider): Configure a custom OpenID Connect (OIDC) compatible authentication provider for your Clerk application.
- [Add Discord as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/discord): Learn how to allow users to sign up and sign in to your Clerk app with their Discord account with OAuth.
- [Account linking for OAuth]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/account-linking): Learn how Clerk handles account linking and manages unverified email addresses from OAuth providers.
- [Add Dropbox as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/dropbox): Learn how to allow users to sign up and sign in to your Clerk app with their Dropbox account using OAuth.
- [Add Apple as a social connection]({{SITE_URL}}/docs/guides/configure/auth-strategies/social-connections/apple): Learn how to allow users to sign up and sign in to your Clerk app with their Apple ID using OAuth.
- [Email and SMS templates]({{SITE_URL}}/docs/guides/customizing-clerk/email-sms-templates): Learn how to configure the theming of Clerk-sent emails and SMS messages.
- [Localization prop (experimental)]({{SITE_URL}}/docs/guides/customizing-clerk/localization): Use the Clerk localizations package to override and provide predefined or custom localizations for your Clerk components, enabling you to offer localized content or tailor the wording to match your brand.
- [Customizing Clerk]({{SITE_URL}}/docs/guides/customizing-clerk/overview): An overview of all customization options in Clerk, including UI styling, navigation menus, localization, and email and SMS templates.
- [Clerk Elements (beta)]({{SITE_URL}}/docs/guides/customizing-clerk/elements/overview): Learn how to use Clerk Elements to build custom UIs on top of the Clerk APIs without having to manage the underlying logic.
- [Primitives]({{SITE_URL}}/docs/guides/customizing-clerk/elements/examples/primitives): Example implementations using Clerk Elements primitives.
- [shadcn/ui]({{SITE_URL}}/docs/guides/customizing-clerk/elements/examples/shadcn-ui): Learn how to compose Clerk Elements with shadcn/ui to build custom sign in and sign up flows.
- [Sign-in]({{SITE_URL}}/docs/guides/customizing-clerk/elements/examples/sign-in): Examples of prebuilt sign-in flows with Clerk Elements.
- [Sign-up]({{SITE_URL}}/docs/guides/customizing-clerk/elements/examples/sign-up): Examples of prebuilt sign-up flows with Clerk Elements.
- [Styling for Clerk Elements]({{SITE_URL}}/docs/guides/customizing-clerk/elements/guides/styling): Learn how to style Clerk Elements.
- [Build a sign-in flow with Clerk Elements]({{SITE_URL}}/docs/guides/customizing-clerk/elements/guides/sign-in): Learn how to build a complete sign-in form with Clerk Elements.
- [Build a sign-up flow with Clerk Elements]({{SITE_URL}}/docs/guides/customizing-clerk/elements/guides/sign-up): Learn how to build a complete sign-up form with Clerk Elements.
- [Common components]({{SITE_URL}}/docs/guides/customizing-clerk/elements/reference/common): Reference documentation for common Clerk Elements components.
- [Sign-in components]({{SITE_URL}}/docs/guides/customizing-clerk/elements/reference/sign-in): Reference documentation for Clerk Elements sign-in components.
- [Sign-up components]({{SITE_URL}}/docs/guides/customizing-clerk/elements/reference/sign-up): Reference documentation for Clerk Elements sign-up components.
- [Manage your workspace]({{SITE_URL}}/docs/guides/dashboard/overview): Learn how to manage your workspace in the Clerk Dashboard, including creating workspaces, inviting team members, and transferring applications.
- [User profile]({{SITE_URL}}/docs/guides/dashboard/user-profile): Learn how to view and manage individual user identity and data in the Clerk Dashboard.
- [Analytics]({{SITE_URL}}/docs/guides/dashboard/analytics): Learn how to use analytics in the Clerk Dashboard to track user engagement, sign-in activity, retention, and more.
- [Manage team access]({{SITE_URL}}/docs/guides/dashboard/manage-team-access): Learn about workspace roles and permissions in the Clerk Dashboard, including Owner, Admin, Developer, Support, and Viewer roles.
- [Organization profile]({{SITE_URL}}/docs/guides/dashboard/organization-profile): Learn how to view and manage organization settings, membership, and data in the Clerk Dashboard.
- [Application Logs]({{SITE_URL}}/docs/guides/dashboard/logs/application-logs): Learn how to use Application Logs in the Clerk Dashboard to monitor authentication events, track user activity, and debug issues across your instance.
- [Proxying the Clerk Frontend API]({{SITE_URL}}/docs/guides/dashboard/dns-domains/proxy-fapi): Learn how to proxy the Clerk Frontend API through your domain.
- [Authentication across different domains]({{SITE_URL}}/docs/guides/dashboard/dns-domains/satellite-domains): Learn how to share sessions across different domains by adding satellite domains to your application.
- [Subdomain allowlist]({{SITE_URL}}/docs/guides/dashboard/dns-domains/subdomain-allowlist): Restrict which subdomains can make cross-domain requests to the Frontend API for stronger security.
- [Restrictions]({{SITE_URL}}/docs/guides/secure/restricting-access): Learn how to manage user access to your application by configuring Clerk's access restrictions.
- [Password protection and rules]({{SITE_URL}}/docs/guides/secure/password-protection-and-rules): Clerk refers to the National Institute of Standards and Technology (NIST) guidelines to determine the character rules for passwords.
- [Securing your app]({{SITE_URL}}/docs/guides/secure/overview): Learn how Clerk protects your application from common security threats including credential stuffing, brute force attacks, XSS, CSRF, and more.
- [Legal compliance]({{SITE_URL}}/docs/guides/secure/legal-compliance): Learn how to configure your legal compliance settings in the Clerk Dashboard.
- [Features]({{SITE_URL}}/docs/guides/secure/features): Grant access to your privileged content and data using features.
- [Client Trust]({{SITE_URL}}/docs/guides/secure/client-trust): Protect your users from credential stuffing attacks with automatic second-factor verification on new devices.
- [Bot protection]({{SITE_URL}}/docs/guides/secure/bot-protection): Protect your sign-ups from bots.
- [Authorization checks]({{SITE_URL}}/docs/guides/secure/authorization-checks): Learn how to verify and validate user Roles and Permissions within Clerk to maintain secure access control.
- [Add reverification for sensitive actions]({{SITE_URL}}/docs/guides/secure/reverification): Learn how to implement Clerk's reverification feature to protect sensitive actions in your application.
- [User enumeration protection]({{SITE_URL}}/docs/guides/secure/user-enumeration-protection): Learn how to protect your users from user enumeration attacks.
- [Session options]({{SITE_URL}}/docs/guides/secure/session-options): Clerk provides session management options for fine-tuning user visits to your application.
- [Rotate your Clerk API keys]({{SITE_URL}}/docs/guides/secure/rotate-api-keys): Learn how to rotate your Clerk Secret Key and webhook signing secrets to revoke access for compromised credentials.
- [Brute force attacks and locking user accounts]({{SITE_URL}}/docs/guides/secure/user-lockout): User information is a prime target for malicious activity. Clerk protects your users against brute force attacks by locking out accounts with too many sign-in attempts until a set period of time has passed.
- [Implement basic Role Based Access Control (RBAC) with metadata]({{SITE_URL}}/docs/guides/secure/basic-rbac): Learn how to leverage Clerk's publicMetadata to implement your own basic Role Based Access Controls.
- [Protect pages in your Nuxt app with Clerk]({{SITE_URL}}/docs/guides/secure/protect-pages): Learn how to protect the pages in your Clerk + Nuxt application.
- [Configure Clerk Content-Security-Policy headers]({{SITE_URL}}/docs/guides/secure/best-practices/csp-headers): Learn how to configure your Content Security Policy to work with the Clerk APIs.
- [CSRF protection]({{SITE_URL}}/docs/guides/secure/best-practices/csrf-protection): CSRF is an attack that tricks the victim into submitting a malicious request. It inherits the identity and privileges of the victim to perform an undesired function on the victim’s behalf.
- [Fixation protection]({{SITE_URL}}/docs/guides/secure/best-practices/fixation-protection): Session fixation is an attack that permits an attacker to hijack a valid user session. The attack explores a limitation in the way the web application manages the session ID, more specifically the vulnerable web application. When authenticating a user, it doesn’t assign a new session ID, making it possible to use an existent session ID.
- [Protect email link sign-ins and sign-ups]({{SITE_URL}}/docs/guides/secure/best-practices/protect-email-links): Learn how to protect email link sign-ins and sign-ups.
- [Unauthorized sign-in]({{SITE_URL}}/docs/guides/secure/best-practices/unauthorized-sign-in): Notify users of unauthorized sign-ins to their accounts
- [XSS leak protection]({{SITE_URL}}/docs/guides/secure/best-practices/xss-leak-protection): Learn how Clerk prevents and mitigates XSS attacks.
- [Session tokens]({{SITE_URL}}/docs/guides/sessions/session-tokens): Learn about session tokens and how to validate them in your backend.
- [Manual JWT verification]({{SITE_URL}}/docs/guides/sessions/manual-jwt-verification): Learn how to manually verify Clerk-generated session tokens (JWTs).
- [JWT templates]({{SITE_URL}}/docs/guides/sessions/jwt-templates): Learn how to create custom JWT templates to generate JSON Web Tokens with Clerk.
- [Force a session token refresh]({{SITE_URL}}/docs/guides/sessions/force-token-refresh): Learn how to force a refresh of a user's session token in your Clerk application.
- [Customize your session token]({{SITE_URL}}/docs/guides/sessions/customize-session-tokens): Learn how to customize the session token that is generated for you by Clerk.
- [Sync auth status between your Chrome Extension and web app]({{SITE_URL}}/docs/guides/sessions/sync-host): Learn how to configure your Chrome Extension to sync user authentication with your web application.
- [Verify a Clerk session in Go]({{SITE_URL}}/docs/guides/sessions/verifying): Learn how to verify a session with Clerk in your Go application.
- [Users]({{SITE_URL}}/docs/guides/users/managing): Learn how to manage your users in your Clerk application.
- [Invite users to your application]({{SITE_URL}}/docs/guides/users/inviting): Learn how to invite users to your Clerk application.
- [User impersonation]({{SITE_URL}}/docs/guides/users/impersonation): Clerk's user impersonation feature allows you to sign in as different users to offer customer support or debug issues.
- [User metadata]({{SITE_URL}}/docs/guides/users/extending): Learn how to store information about a user that Clerk doesn't collect and extend the User object.
- [Override Clerk interfaces with custom types]({{SITE_URL}}/docs/guides/development/override-clerk-types-interfaces): Learn about the interfaces that you can use to define custom types for your application.
- [Instances / Environments]({{SITE_URL}}/docs/guides/development/managing-environments): An overview of the differences between development and production instances.
- [Making authenticated requests]({{SITE_URL}}/docs/guides/development/making-requests): Learn about various ways to make authenticated requests to the backend when using Clerk SDKs.
- [Use image optimization to improve app performance]({{SITE_URL}}/docs/guides/development/image-optimization): Learn how to use image optimization when fetching user images from Clerk.
- [Customize your redirect URLs]({{SITE_URL}}/docs/guides/development/customize-redirect-urls): Customize where your users are redirected to after they sign in or sign up.
- [Clerk environment variables]({{SITE_URL}}/docs/guides/development/clerk-environment-variables): Learn which Clerk environment variables are necessary to configure your projects.
- [Add custom onboarding to your authentication flow]({{SITE_URL}}/docs/guides/development/add-onboarding-flow): Leverage Clerk’s customizable session tokens, public metadata, and Middleware to create a robust onboarding experience.
- [Install Clerk with shadcn/ui CLI]({{SITE_URL}}/docs/guides/development/shadcn-cli): Use the shadcn/ui CLI to bootstrap your Next.js app with Clerk.
- [Next.js rendering modes and Clerk]({{SITE_URL}}/docs/guides/development/rendering-modes): Learn how Clerk's SDK interacts with Next.js's different rendering modes.
- [Integrate Clerk into your Next.js + tRPC app]({{SITE_URL}}/docs/guides/development/trpc): Learn how to integrate Clerk into your Next.js app using tRPC.
- [Basic geo blocking]({{SITE_URL}}/docs/guides/development/geo-blocking): Learn how to add geo blocking to your Next.js + Clerk application.
- [Verify API keys in your Next.js application with Clerk]({{SITE_URL}}/docs/guides/development/verifying-api-keys): Learn how to use Clerk's helpers to verify API keys in your Next.js application.
- [Add React Router to your Clerk-powered Chrome Extension]({{SITE_URL}}/docs/guides/development/add-react-router): Learn how to add React Router to your React app using their Data API router.
- [Configure a consistent CRX ID for your Chrome Extension]({{SITE_URL}}/docs/guides/development/configure-consistent-crx-id): Learn how to configure a consistent CRX ID in your Chrome Extension.
- [Enable biometric sign-in for returning users in Expo]({{SITE_URL}}/docs/guides/development/local-credentials): Learn how to use the useLocalCredentials() hook in your Expo app to enable biometric sign-ins for returning users.
- [Access the Clerk object outside of components]({{SITE_URL}}/docs/guides/development/access-clerk-outside-components): Learn how to access and use the Clerk instance outside of React components in Expo applications.
- [Enable offline support in your Expo app]({{SITE_URL}}/docs/guides/development/offline-support): Learn how to enable offline support in your Expo app with Clerk.
- [Astro hybrid rendering]({{SITE_URL}}/docs/guides/development/hybrid-rendering): Clerk's Astro SDK supports Astro's on-demand rendering output modes (server and hybrid).
- [Endpoints]({{SITE_URL}}/docs/guides/development/endpoints): Learn how to use Clerk's Astro SDK in your Astro endpoints.
- [Build your own sign-in-or-up page for your Expo web app]({{SITE_URL}}/docs/guides/development/web-support/custom-sign-in-or-up-page): Learn how to add custom sign-in-or-up page to your Expo web app with Clerk's prebuilt components.
- [Web support]({{SITE_URL}}/docs/guides/development/web-support/overview): Add web support to your Expo project with Clerk.
- [Build your own sign-up page with prebuilt components on web]({{SITE_URL}}/docs/guides/development/web-support/custom-sign-up-page): Learn how to add custom sign-up page to your Expo app with Clerk's prebuilt components.
- [Debug your webhooks]({{SITE_URL}}/docs/guides/development/webhooks/debugging): Understand how to debug your webhooks while developing your application
- [Handling webhooks with Inngest]({{SITE_URL}}/docs/guides/development/webhooks/inngest): Learn how to integrate Clerk with Inngest.
- [Integrate Loops with Clerk]({{SITE_URL}}/docs/guides/development/webhooks/loops): Learn how to add your Clerk users to your Loops audience, and send automated email sequences.
- [Webhooks overview]({{SITE_URL}}/docs/guides/development/webhooks/overview): Clerk webhooks allow you to receive event notifications from Clerk.
- [Sync Clerk data to your app with webhooks]({{SITE_URL}}/docs/guides/development/webhooks/syncing): Learn how to sync Clerk data to your app with webhooks.
- [Migrate from Cognito]({{SITE_URL}}/docs/guides/development/migrating/cognito): Seamlessly migrate AWS Cognito user passwords into Clerk.
- [Migrate from Firebase]({{SITE_URL}}/docs/guides/development/migrating/firebase): Migrating your user base from Firebase to Clerk is a 2-part process that can be accomplished with just a few steps.
- [Migrating]({{SITE_URL}}/docs/guides/development/migrating/overview): Guides on how to move your user data from another authentication platform to Clerk.
- [Migrate from Auth.js to Clerk]({{SITE_URL}}/docs/guides/development/migrating/authjs): Learn how to migrate an application using Auth.js to use Clerk for authentication.
- [Migrating from the Astro community SDK]({{SITE_URL}}/docs/guides/development/migrating/astro-community-sdk): Learn how to migrate from the Astro community SDK to the Clerk Astro SDK.
- [Migrating from the Vue community SDK]({{SITE_URL}}/docs/guides/development/migrating/vue-community-sdk): Learn how to migrate from the Vue community SDK to the Clerk Vue SDK.
- [Email deliverability]({{SITE_URL}}/docs/guides/development/troubleshooting/email-deliverability): A lot goes into making sure verification emails make it to your customers as quickly as possible. Clerk uses every best practice, and is proactive about monitoring verification email deliverability and speed. Behind the scenes, Clerk uses Sendgrid using a pool of dedicated IP addresses to ensure that our reputation stays perfect.
- [New domain reputation and email warm-up]({{SITE_URL}}/docs/guides/development/troubleshooting/email-domain-name-warmup): Learn how email providers evaluate new domains, how to warm up your domain for reliable verification email delivery, and what metrics to monitor as a Clerk customer.
- [Decode Clerk JWTs]({{SITE_URL}}/docs/guides/development/troubleshooting/jwt-decoder): Decode JWTs and inspect claims.
- [Troubleshooting]({{SITE_URL}}/docs/guides/development/troubleshooting/overview): Learn how to troubleshoot common issues with Clerk and contact support for additional assistance.
- [Script loading]({{SITE_URL}}/docs/guides/development/troubleshooting/script-loading): Troubleshooting strategies for cases when Clerk doesn't successfully load
- [Using production keys in local development]({{SITE_URL}}/docs/guides/development/troubleshooting/using-production-keys-in-development): Learn how to use your production Clerk instance locally for debugging.
- [Create a browser replay]({{SITE_URL}}/docs/guides/development/troubleshooting/help-support/browser-replay): Learn how to record replays and share them with Clerk Support.
- [Create a minimal reproduction]({{SITE_URL}}/docs/guides/development/troubleshooting/help-support/create-a-minimal-reproduction): Learn how to create a minimal reproduction in order to help the Clerk Support team debug and resolve issues specific to your application.
- [Using API keys]({{SITE_URL}}/docs/guides/development/machine-auth/api-keys): Learn how to use Clerk's API keys feature to let your application's users create API keys that delegate access to your application's API on their behalf.
- [Using M2M tokens]({{SITE_URL}}/docs/guides/development/machine-auth/m2m-tokens): Learn how to use Clerk's M2M tokens feature to authenticate requests between machines.
- [Machine Authentication]({{SITE_URL}}/docs/guides/development/machine-auth/overview): Learn what machine authentication is, why it's used, and how it works with Clerk.
- [Token formats]({{SITE_URL}}/docs/guides/development/machine-auth/token-formats): Learn about the differences between JWT and opaque token formats for machine authentication.
- [Testing]({{SITE_URL}}/docs/guides/development/testing/overview): Learn about testing with Clerk.
- [Testing with Postman or Insomnia]({{SITE_URL}}/docs/guides/development/testing/postman-or-insomnia): Learn about generating and using a long-lived JWT Token with Postman or Insomnia.
- [Test emails and phones]({{SITE_URL}}/docs/guides/development/testing/test-emails-and-phones): Write end to end tests by simulating OTP verifications.
- [Testing with Playwright]({{SITE_URL}}/docs/guides/development/testing/playwright/overview): Use Playwright to write end-to-end tests with Clerk.
- [Reuse auth state across tests]({{SITE_URL}}/docs/guides/development/testing/playwright/test-authenticated-flows): Learn how to save and reuse authenticated state across Playwright tests.
- [Test helpers]({{SITE_URL}}/docs/guides/development/testing/playwright/test-helpers): Use test helpers to sign in/sign out with Clerk in your Playwright tests.
- [Test the sign-up form]({{SITE_URL}}/docs/guides/development/testing/playwright/test-sign-up-flows): Learn how to test the sign-up form with Playwright, including additional fields like first and last name.
- [Custom commands]({{SITE_URL}}/docs/guides/development/testing/cypress/custom-commands): Use custom commands to sign in and out with Clerk in your Cypress tests.
- [Testing with Cypress]({{SITE_URL}}/docs/guides/development/testing/cypress/overview): Use Cypress to write end-to-end tests with Clerk.
- [Test Account Portal flows]({{SITE_URL}}/docs/guides/development/testing/cypress/test-account-portal): Learn how to test the Account Portal flow with Cypress.
- [Integrations]({{SITE_URL}}/docs/guides/development/integrations/overview): Learn about the available integrations with Clerk.
- [Integrate Shopify with Clerk]({{SITE_URL}}/docs/guides/development/integrations/platforms/shopify): Learn how to integrate Clerk into your Shopify store.
- [Integrate Clerk through the Vercel Marketplace]({{SITE_URL}}/docs/guides/development/integrations/platforms/vercel-marketplace): Learn how to integrate Clerk into your Vercel projects through the Vercel Marketplace.
- [Integrate Encore with Clerk]({{SITE_URL}}/docs/guides/development/integrations/frameworks/encore): Learn how to integrate Clerk for secure authentication and user management into your Encore backend application.
- [Integrate Convex with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/convex): Learn how to integrate Clerk into your Convex application.
- [Integrate Firebase with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/firebase): Learn how to integrate Clerk into your Firebase application.
- [Integrate Grafbase with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/grafbase): Learn how to integrate Clerk and Grafbase into your application
- [Integrate Hasura with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/hasura): Learn how to integrate Clerk into your Hasura application.
- [Integrate InstantDB with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/instantdb): Learn how to integrate Clerk into your InstantDB application.
- [Integrate Neon Postgres with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/neon): Learn how to integrate Clerk into your Neon application.
- [Integrate Nhost with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/nhost): Learn how to integrate Clerk into your Nhost project.
- [Integrate Prisma Postgres with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/prisma-postgres): Learn how to integrate Clerk into your Prisma Postgres application.
- [Integrate Supabase with Clerk]({{SITE_URL}}/docs/guides/development/integrations/databases/supabase): Learn how to integrate Clerk into your Supabase application.
- [Enable Google Analytics for Clerk]({{SITE_URL}}/docs/guides/development/integrations/analytics/google-analytics): Enable Clerk with Google Analytics to authenticate requests to your application.
- [Upgrade guides overview]({{SITE_URL}}/docs/guides/development/upgrading/overview): Learn how to upgrade your application to use the latest Clerk features and SDKs.
- [Upgrading from v2 to v3]({{SITE_URL}}/docs/guides/development/upgrading/upgrading-from-v2-to-v3): Learn how to upgrade from version 2 to version 3 of the Clerk JavaScript libraries.
- [Versioning overview]({{SITE_URL}}/docs/guides/development/upgrading/versioning): A brief guide on how versioning works in Clerk.
- [Upgrade to API version 2025-11-10]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/2025-11-10): Learn how to upgrade to version 2025-11-10 of Clerk's API.
- [Upgrading to Clerk Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2): Learn how to upgrade to the latest version of Clerk's SDKs
- [Upgrading to Clerk Core 3]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-3): Learn how to upgrade to Clerk Core 3 across all SDKs.
- [Upgrade from Clerk's Node SDK to the Express SDK]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/node-to-express): Learn how to upgrade from the Clerk's Node SDK to the Express SDK.
- [Upgrade to @clerk/nextjs v6]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/nextjs-v6): Learn how to upgrade your application to use the latest Clerk Next.js SDK with support for Next.js 15.
- [Upgrade to @clerk/clerk-expo v2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/expo-v2): Learn how to upgrade your application to use the latest Clerk Expo SDK.
- [Migrate from Clerk Android SDK v0 to v1]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/android-v1): Update to v1 of the Clerk Android SDK.
- [Migrate from Clerk iOS SDK v0 to v1]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/ios-v1): Update imports, configuration, environment wiring, and sign-in code when moving to v1.
- [Upgrading `@clerk/chrome-extension` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/chrome-extension): Learn how to upgrade Clerk's Chrome Extension SDK to the latest version.
- [Upgrading `@clerk/clerk-expo` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/expo): Learn how to upgrade Clerk's Expo SDK to the latest version.
- [Upgrading `@clerk/fastify` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/fastify): Learn how to upgrade Clerk's Fastify SDK to the latest version.
- [Upgrading `@clerk/clerk-js` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/javascript): Learn how to upgrade Clerk's Javascript SDK to the latest version.
- [Upgrading `@clerk/nextjs` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/nextjs): Learn how to upgrade Clerk's Next.js SDK to the latest version.
- [Upgrading `@clerk/clerk-sdk-node` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/node): Learn how to upgrade Clerk's Node SDK to the latest version.
- [Upgrading `@clerk/clerk-react` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/react): Learn how to upgrade Clerk's React SDK to the latest version.
- [Upgrading `@clerk/remix` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/remix): Learn how to upgrade from the Clerk Remix SDK to the latest version.
- [Upgrading `@clerk/backend` to Core 2]({{SITE_URL}}/docs/guides/development/upgrading/upgrade-guides/core-2/backend): Learn how to upgrade the @clerk/backend package to the latest version.
- [Frontend-only SDK]({{SITE_URL}}/docs/guides/development/sdk-development/frontend-only): A reference for implementing a frontend-only Clerk SDK
- [Fullstack SDK]({{SITE_URL}}/docs/guides/development/sdk-development/fullstack): A reference for implementing a fullstack Clerk SDK
- [SDK development]({{SITE_URL}}/docs/guides/development/sdk-development/overview): A reference for implementing a new Clerk SDK from scratch.
- [Philosophy]({{SITE_URL}}/docs/guides/development/sdk-development/philosophy): The guiding principle for building a Clerk SDK.
- [Terminology]({{SITE_URL}}/docs/guides/development/sdk-development/terminology): A list of common terms and their explanations used inside Clerk's SDKs.
- [SDK types]({{SITE_URL}}/docs/guides/development/sdk-development/types): Learn about the three different types of SDKs: frontend-only, backend-only, and fullstack.
- [Backend-only SDK]({{SITE_URL}}/docs/guides/development/sdk-development/backend-only): A reference for implementing a backend-only Clerk SDK
- [Conventions]({{SITE_URL}}/docs/guides/development/sdk-development/conventions): A set of agreed standards for building Clerk SDKs.
- [Deploy a Clerk app behind a proxy]({{SITE_URL}}/docs/guides/development/deployment/behind-a-proxy): Learn how to deploy a Clerk app to a web server using proxies and reverse proxies like nginx or Caddy, or using Docker.
- [Change domain or subdomain]({{SITE_URL}}/docs/guides/development/deployment/changing-domains): Learn how to change your Clerk production instance's domain or subdomain.
- [Deploy your Clerk app to production]({{SITE_URL}}/docs/guides/development/deployment/production): Learn how to deploy your Clerk app to production.
- [Staging alternatives]({{SITE_URL}}/docs/guides/development/deployment/staging-alternatives)
- [Deploying a Clerk app to Vercel]({{SITE_URL}}/docs/guides/development/deployment/vercel): Learn how to deploy a Clerk app to Vercel.
- [Deploy a Chrome Extension to production]({{SITE_URL}}/docs/guides/development/deployment/chrome-extension): Learn how to deploy a Chrome Extension to production with Clerk.
- [Deploy an Expo app to production]({{SITE_URL}}/docs/guides/development/deployment/expo): Learn how to deploy an Expo app to production with Clerk.
- [Deploy an Astro app to production]({{SITE_URL}}/docs/guides/development/deployment/astro): Learn how to deploy an Astro app to production with Clerk.
- [Build your own UI (custom flows)]({{SITE_URL}}/docs/guides/development/custom-flows/overview): Learn the process behind building custom sign-up and sign-in flows with Clerk.
- [Build a custom flow for managing API keys]({{SITE_URL}}/docs/guides/development/custom-flows/api-keys/manage-api-keys): Learn how to use the Clerk API to build a custom flow for creating, listing, and revoking API keys.
- [Build a custom flow for adding an email to a user's account]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/add-email): Learn how to use the Clerk API to 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]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/add-phone): Learn how to use the Clerk API to build a custom flow for adding a phone number to a user's account.
- [Build a custom flow for resetting a user's password]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/forgot-password): Learn how to build a custom flow using Clerk's API to reset a user's password.
- [Build a custom flow for managing multi-factor authentication]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/manage-mfa): Learn how to use the Clerk API to build a custom flow for managing multi-factor authentication.
- [Build a custom flow for managing SSO connections]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/manage-sso-connections): Learn how to use the Clerk API to build a custom flow for adding and managing SSO connections
- [Build a custom flow for resetting a user's password]({{SITE_URL}}/docs/guides/development/custom-flows/account-updates/legacy/forgot-password): Learn how to build a custom flow using Clerk's API to reset a user's password.
- [Handle accepting Organization invitation links]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/accept-organization-invitations): Learn how to use the Clerk API to build a custom flows for accepting Organization invitations.
- [Build a custom flow for creating Organizations]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/create-organizations): Learn how to use the Clerk API to build a custom flow for creating Organizations.
- [Build a custom flow for switching Organizations]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/organization-switcher): Learn how to use the Clerk API to build a custom flow for switching between Organizations.
- [Build a custom flow for updating an Organization]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/update-organizations): Learn how to use the Clerk API to build a custom flow for updating an Organization in your application.
- [Build a custom flow for managing Organization membership requests]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/manage-membership-requests): Learn how to use the Clerk API to build a custom flow for managing Organization membership requests.
- [Build a custom flow for creating and managing Organization invitations]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/manage-organization-invitations): Learn how to use the Clerk API to build a custom flow for creating and managing Organization invitations.
- [Build a custom flow for managing member Roles in an Organization]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/manage-roles): Learn how to use the Clerk API build a custom flow for managing member Roles in an Organization.
- [Build a custom flow for managing a user's Organization invitations]({{SITE_URL}}/docs/guides/development/custom-flows/organizations/manage-user-org-invitations): Learn how to use the Clerk API to build a custom flow for managing a user's Organization invitations.
- [Build a custom sign-in flow with client trust]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/client-trust): Learn how to build a custom sign-in flow that requires Client Trust.
- [Build a custom email/password authentication flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/email-password): Learn how to build a custom email/password sign-up and sign-in flow using the Clerk API.
- [Build a custom sign-in flow with email or phone code]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/email-sms-otp): Learn how build a custom passwordless sign-in flow with email or phone code using the Clerk API.
- [Build a custom flow for authenticating with enterprise connections]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/enterprise-connections): Learn how to use the Clerk API to build a custom sign-up and sign-in flow that supports enterprise connections.
- [Build a custom flow for displaying the last authentication method]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/last-authentication-strategy): Learn how to use the Clerk API to build a custom flow for displaying the lastAuthenticationStrategy property and highlighting the last used OAuth provider with a badge.
- [Build a custom flow for handling legal acceptance]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legal-acceptance): Learn how to use the Clerk API to build a custom user interface for handling legal acceptance.
- [Build a custom sign-in flow with multi-factor authentication (MFA)]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/multi-factor-authentication): Learn how to build a custom sign-in flow that requires multi-factor authentication (MFA).
- [Build a custom multi-session flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/multi-session-applications): Learn how to use the Clerk API to add multi-session handling to your application.
- [Build a custom flow for authenticating with OAuth connections]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/oauth-connections): Learn how to use the Clerk API to build a custom sign-up and sign-in flow that supports OAuth connections.
- [Build a custom authentication flow using passkeys]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/passkeys): Learn how to use the Clerk API to build a custom authentication flow using passkeys.
- [Session tasks]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/session-tasks): Learn how to handle session tasks in your custom authentication flow.
- [Sign-in-or-up custom flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/sign-in-or-up): Learn how to handle a combined sign-up and sign-in flow in your application.
- [Build a custom sign-out flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/sign-out): Learn how to use the Clerk API to build a custom sign-out flow using Clerk's signOut() function.
- [Sign-up with application invitations]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/application-invitations): Learn how to use the Clerk API to build a custom flow for handling application invitations.
- [Build a custom authentication flow using passkeys]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/passkeys): Learn how to use the Clerk API to build a custom authentication flow using passkeys.
- [Build a custom flow for authenticating with OAuth connections]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/oauth-connections): Learn how to use the Clerk API to build a custom sign-up and sign-in flow that supports OAuth connections.
- [Sign-in-or-up custom flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/sign-in-or-up): Learn how to handle a combined sign-up and sign-in flow in your application.
- [Sign-up with application invitations]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/application-invitations): Learn how to use the Clerk API to build a custom flow for handling application invitations.
- [Build a custom sign-in flow with multi-factor authentication]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/email-password-mfa): Learn how to build a custom email/password sign-in flow that requires multi-factor authentication (MFA).
- [Build a custom email/password authentication flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/email-password): Learn how to build a custom email/password sign-up and sign-in flow using the Clerk API.
- [Build a custom email or phone OTP authentication flow]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/email-sms-otp): Learn how to build a custom email or phone one time code (OTP) authentication flow using the Clerk API.
- [Build a custom flow for authenticating with enterprise connections]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/enterprise-connections): Learn how to use the Clerk API to build a custom sign-up and sign-in flow that supports enterprise connections.
- [Build a custom flow for displaying the last authentication method]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/last-authentication-strategy): Learn how to use the Clerk API to build a custom flow for displaying the lastAuthenticationStrategy property and highlighting the last used OAuth provider with a badge.
- [Build a custom flow for handling legal acceptance]({{SITE_URL}}/docs/guides/development/custom-flows/authentication/legacy/legal-acceptance): Learn how to use the Clerk API to build a custom user interface for handling legal acceptance.
- [Backend API errors]({{SITE_URL}}/docs/guides/development/errors/backend-api): An index of Clerk Backend API errors.
- [Frontend API errors]({{SITE_URL}}/docs/guides/development/errors/frontend-api): An index of Clerk Frontend API errors.
- [Errors overview]({{SITE_URL}}/docs/guides/development/errors/overview): Find more information about a Clerk error.