Add Directory Sync to Your Node.js App Using WorkOS

October 13, 2021

If your SaaS product is built with Node.js and you want to incorporate Directory Sync functionality, you can do a dry-run of the Directory Sync integration on our example Node.js app which makes use of the WorkOS Node.js SDK.

If you get stuck while following the steps below and aren't able to resolve the issue by reading our API reference or Directory Sync Setup Guide, reach out to us at [email protected] so we can help!


Node Project Setup

1. In your CLI, navigate to the directory into which you want to clone this git repo:

2. Clone this repo and install dependencies:


3. Navigate to the cloned repo:

4. Install the dependencies:

Securely store the environment variables

5. Obtain and make note of your WorkOS API key and WorkOS Client ID from the WorkOS Dashboard. The locations of these values are shown in the screenshots below.

6. Create a .env file in the example app’s project directory, node-directory-sync-example/. (This file is listed in this repo's .gitignore file, so your sensitive information will not be checked into version control.)

7. Open the .env file with your preferred text editor and add the WORKOS_API_KEY and WORKOS_CLIENT_ID:

Start the server

8. To ensure the example app is served as expected, start the server:

9. Navigate to http://localhost:8000/ to view your directories! You should see a WorkOS-branded example webpage that lists your directories (if any have been set up yet).

Need help?

If you get stuck and aren't able to resolve the issue by reading our WorkOS Directory Sync documentation, API reference, or tutorials, you can reach out to us at [email protected] and we'll lend a hand.

Start Integrating Today
Create an account to begin adding enterprise-ready features to your application today.
Get Started

This site uses cookies to improve your experience. Please accept the use of cookies on this site. You can review our cookie policy here and our privacy policy here. If you choose to refuse, functionality of this site will be limited.