Node.js Example App with SSO powered by WorkOS

An example application demonstrating to use the WorkOS Node SDK to authenticate users via SSO.

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-sso-example.git

   or

   # SSH
   git clone https://github.com/workos-inc/node-sso-example.git && cd node-sso-example && npm install

3. Navigate to the cloned repo.

   $ cd node-sso-example

4. Install the dependencies.

   $ npm install

Configure your environment

5. Grab your API Key and Client ID from the WorkOS Dashboard. Create a .env file at the root of the project, and store these like so:

   WORKOS_API_KEY=sk_xxxxxxxxxxxxx
   WORKOS_CLIENT_ID=project_xxxxxxxxxxxx
   

SSO Setup with WorkOS

6. Follow the SSO authentication flow instructions to create a new SSO connection in your WorkOS dashboard.

7. Add http://localhost:3000/callback as a Redirect URI in the Configuration section of the Dashboard.

8. Update routes/index.js with the Connection domain (or Connection ID).

Testing the Integration

9. Start the server and head to `http://localhost:3000/ to begin the login flow!

npm start

Need help?

If you get stuck and aren't able to resolve the issue by reading our WorkOS Node SDK documentation, API reference, or tutorials, you can reach out to us at support@workos.com and we'll lend a hand.