Prepare for the PgBouncer and IPv4 deprecations on 26th January 2024

Learn more
Home

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

Log in to the dashboard and hop over to the Organizations tab to create and organization Create an 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

Fetch Client ID and configure Redirect URI

Obtain the WorkOS secret

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

WorkOS Secret Key

Connect a WorkOS supported identity provider

Set up the identity provider by visiting the setup link.

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

Add login code to your client app

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


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

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:


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

Resources