Skip to content

Files

Latest commit

23d7197 · Jun 1, 2023

History

History

sdk-node

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Dec 13, 2022
Dec 13, 2022
Mar 16, 2023
Jan 9, 2023
Mar 22, 2022
Jun 1, 2023
Dec 9, 2022
Dec 23, 2021
May 26, 2023
Jun 15, 2022
May 8, 2023
Jan 5, 2023
Jun 1, 2023
Mar 13, 2023
Dec 13, 2022


@clerk/clerk-sdk-node


Overview

Clerk is the easiest way to add authentication and user management to your Node.js application. To gain a better understanding of the Clerk Backend API and SDK, refer to the Node SDK and Backend API documentation.

Getting started

Prerequisites

  • Node.js v14+

Installation

npm install @clerk/clerk-sdk-node

To build the package locally with the TypeScript compiler, run:

npm run build

Usage

Retrieve your Backend API key from the API Keys screen in your Clerk dashboard and set it as an environment variable in a .env file:

CLERK_PUBLISHABLE_KEY=pk_*******
CLERK_SECRET_KEY=sk_******

You will then be able to access all the available methods.

import 'dotenv/config'; // To read CLERK_API_KEY
import clerk from '@clerk/clerk-sdk-node';

const userList = await clerk.users.getUserList();

For further details and examples, please refer to our Documentation.

Support

You can get in touch with us in any of the following ways:

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines.

Security

@clerk/clerk-sdk-node follows good practices of security, but 100% security cannot be assured.

@clerk/clerk-sdk-node is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.