workos / node-admin-portal-example

An example Node application demonstrating how to use the WorkOS Node SDK to support Admin Portal.

Node.js Example App with Admin Portal powered by WorkOS

An example application demonstrating to use the WorkOS Node SDK to access the Admin Portal for SSO and Directory Sync.

Prerequisites

Node.js version 10+

Node Project Setup

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

   $ cd ~/Desktop/

2. Clone this repo and install dependencies:

   # HTTPS
   git clone https://github.com/workos-inc/node-admin-portal-example.git

   or

   # SSH
   git clone [email protected]:workos-inc/node-admin-portal-example.git

3. Navigate to the cloned repo.

   $ cd node-admin-portal-example

4. Install the dependencies.

   $ npm install

Configure your environment

1. Grab your API Key.
2. Get your Client ID.
3. Create a .env file at the root of the project and populate with the following environment variables (using values found above):

WORKOS_API_KEY=your_api_key_here
WORKOS_CLIENT_ID=your_client_id_here

4. Set your Default Redirect Link.

Run the server and log in using SSO

npm start

Head to http://localhost:8000/ to begin!

Need help?

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