Add the WorkOS Admin Portal to Your Node.js App

October 27, 2021

If your SaaS product is built with Node.js and you want to incorporate WorkOS’ Admin Portal functionality, you can do a dry-run of the Admin Portal 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 Admin Portal Setup Guide, reach out to us at [email protected] so we can help!

Prerequisites

  • Node.js version 10+
  • npm or yarn (we'll use npm in this tutorial)
  • A free WorkOS account

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 Node.js Admin Portal example app, located within the cloned repo:

4. Install the dependencies:


Securely store the environment variables

5. Obtain and make note of your WorkOS API key and SSO-specific, 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:


Update the Admin Portal Redirect Link

9. Update the Admin Portal Redirect Link at the bottom of the "Configuration" page of your WorkOS Dashboard. The URL to use is http://localhost:8000.

After an Admin Portal user creates an SSO connection using the Admin Portal, they need to be redirected to a webpage within your application (usually this webpage confirms successful creation of the connection). To configure which webpage this is, enter the webpage’s URL in the Configuration section of your WorkOS dashboard under the “Admin Portal Redirect Link” header. For production usage this URL must begin with HTTPS, but for development purposes the URL can begin with HTTP.

10. With the Node server running, navigate to http://localhost:8000/ to view the example Admin Portal!

11. Enter the name of the new Organization to be created and the names of all of the Organization's associated domains.

  • The Organization must be a new Organization that doesn't yet exist in your WorkOS dashboard
  • The domains should be entered as space-separated values, e.g. "domain1.com domain2.com domain3.com"

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.

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.