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:

User get operations

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

User create operations

• createUser()

User update operations

• updateUser()

User delete operations

• deleteUser()

Organization operations

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

Organization get operations

• getOrganization()
• getOrganizationList()
• getOrganizationMembershipList()
• getOrganizationInvitationList()

Organization create operations

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

Organization update operations

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

Organization delete operations

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

Allowlist Identifiers operations

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

Allowlist Identifiers get operations

• getAllowlistIdentifierList()

Allowlist Identifiers create operations

• createAllowlistIdentifier()

Allowlist Identifiers delete operations

• deleteAllowlistIdentifier()

Session operations

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

Session get operations

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

Session delete operations

• revokeSession()

Client operations

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

Client get operations

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

Invitation operations

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

Invitation get operations

• getInvitationList()

Invitation create operations

• createInvitation()

Invitation delete operations

• revokeInvitation()

Email create operations (deprecated)

SMS message operations (deprecated)