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.

User operations

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

Get

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

Create

• createUser()

Update

• updateUser()

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()
• 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 operations

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

Create

• createEmail()

SMS message operations

SMS message operations are exposed under clerkClient.smsMessages. The following methods are available:

Create

• createSMSMessage()