Clerk Backend SDK

The Clerk Backend SDK⁠ exposes Clerk's backend API resources and low-level authentication utilities for JavaScript environments. While the backend SDK is mainly used as a building block for Clerk's higher-level SDKs, it can also be used on its own for advanced flows and custom integrations.

Clerk SDKs expose an instance of the Clerk Backend SDK for use in server environments.

import { clerkClient } from '@clerk/nextjs';

import { createClerkClient } from '@clerk/remix/api.server';

import { clerkClient } from "@clerk/fastify";

import clerkClient from '@clerk/clerk-sdk-node';

User operations

User operations are exposed under clerkClient.users. The following methods are available:

Get

• getUserList()
• getUser()
• getCount()

Create

• createUser()

Update

• updateUser()
• updateUserMetadata()

Delete

• deleteUser()

Organization operations

Organization operations are exposed under clerkClient.organizations. The following methods are available:

Get

• getOrganization()
• getOrganizationList()
• getOrganizationMembershipList()
• getPendingOrganizationInvitationList()

Create

• createOrganization()
• createOrganizationMembership()
• createOrganizationInvitation()

Update

• updateOrganization()
• updateOrganizationMembership()
• updateOrganizationMetadata()
• updateOrganizationMembershipMetadata()

Delete

• deleteOrganization()
• deleteOrganizationMembership()
• revokeOrganizationInvitation()

Allowlist Identifiers operations

Allowlist Identifiers operations are exposed under clerkClient.allowlistIdentifiers. The following methods are available:

Get

• getAllowlistIdentifierList()

Create

• createAllowlistIdentifier()

Delete

• deleteAllowlistIdentifier()

Session operations

Session operations are exposed under clerkClient.sessions. The following methods are available:

Get

• getSession()
• getSessionList()
• getToken()
• authenticateRequest()
• verifySession()

Delete

• revokeSession()

Client operations

Client operations are exposed under clerkClient.clients. The following methods are available:

Get

• getClient()
• getClientList()
• verifyClient()

Invitation operations

Invitation operations are exposed under clerkClient.invitations. The following methods are available:

Get

• getInvitationList()

Create

• createInvitation()

Delete

• revokeInvitation()

Email address operations

A user can be associated with one or more email addresses.

Email address operations are exposed under clerkClient.emailAddresses. The following methods are available:

Email address get operations

• getEmailAddress()

Email address create operations

• createEmailAddress()

Email address update operations

• updateEmailAddress()

Email address delete operations

• deleteEmailAddress()

Email operations

SMS message operations (deprecated)