Login with WorkOS

To enable WorkOS Auth for your project, you need to set up WorkOS OAuth application and add the application credentials to your Supabase Dashboard.

Overview#

In this guide, we will cover how to use Supabase OAuth with WorkOS to implement Single-Sign-On(SSO).

The procedure consists of five broad steps:

Create a new organization from your WorkOS Dashboard.
Obtain the Client ID from the Configuration tab and configure redirect URI.
Obtain the WorkOS Secret from the credentials tab.
Connect a WorkOS Supported Identity Provider
Add your WorkOS credentials into your Supabase project

Create a WorkOS Organization#

Obtain the Client ID and configure Redirect URI#

Head over to the Configuration tab and configure the redirect URI.The redirect URI should look like https://<project-ref>.supabase.co/auth/v1/callback Note that this is distinct from the redirect URI referred to in the Supabase dashboard

Obtain the WorkOS Secret#

Head over to the API Keys page and obtain the secret key.

Connect a WorkOS Supported Identity Provider#

Set up the identity provider by visiting the setup link.

You can pick between any one of the many identity providers that WorkOS supports.

Add your WorkOS credentials into your Supabase Project#

Go to your Supabase Project Dashboard
In the left sidebar, click the Authentication icon (near the top)
Click on Providers under the Configuration section
Click on WorkOS from the accordion list to expand and turn WorkOS Enabled to ON
Enter your WorkOS Client ID and WorkOS Client Secret saved in the previous step
Click Save

When your user signs in, call signInWithOAuth() with workos as the provider:

async function signInWithWorkOS() {
  const { data, error } = await supabase.auth.signInWithOAuth({
    provider: 'workos',
    options: {
      queryParams: {
        connection: '<your_connection>',
        organization: '<your_organization',
        provider: '<your_provider>',
      },
    },
  })
}

Refer to the WorkOS Documentation to learn more about the different methods.

When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:

async function signOut() {
  const { error } = await supabase.auth.signOut()
}

Resources#

WorkOS Documentation

Edit this page on GitHub