Login with Slack
To enable Slack Auth for your project, you need to set up a Slack OAuth application and add the application credentials to your Supabase Dashboard.
Overview
We will be replacing the existing Slack provider with a new Slack (OIDC) provider. Developers with Slack OAuth Applications created prior to 24th June 2024 should create a new application and migrate their credentials from the Slack provider to the Slack (OIDC) provider. Existing OAuth Applications built with the old Slack provider will continue to work up till 10th October. You can refer to the list of supported scopes for the new Slack (OIDC) User.
Setting up Slack logins for your application consists of 3 parts:
- Create and configure a Slack Project and App on the Slack Developer Dashboard.
- Add your Slack
API Key
andAPI Secret Key
to your Supabase Project. - Add the login code to your Supabase JS Client App.
Access your Slack Developer account
- Go to api.slack.com.
- Click on
Your Apps
at the top right to log in.
Find your callback URL
The next step requires a callback URL, which looks like this: https://<project-ref>.supabase.co/auth/v1/callback
- Go to your Supabase Project Dashboard
- Click on the
Authentication
icon in the left sidebar - Click on
Providers
under the Configuration section - Click on Slack from the accordion list to expand and you'll find your Callback URL, you can click
Copy
to copy it to the clipboard
For testing OAuth locally with the Supabase CLI please see the local development docs.
Create a Slack OAuth app
- Go to api.slack.com.
- Click on
Create New App
Under Create an app...
:
- Click
From scratch
- Type the name of your app
- Select your
Slack Workspace
- Click
Create App
Under App Credentials
:
- Copy and save your newly-generated
Client ID
- Copy and save your newly-generated
Client Secret
Under the sidebar, select OAuth & Permissions
and look for Redirect URLs
:
- Click
Add New Redirect URL
- Paste your
Callback URL
then clickAdd
- Click
Save URLs
Under Scopes
:
- Add the following scopes under the
User Token Scopes
:profile
,email
,openid
. These scopes are the default scopes that Supabase Auth uses to request for user information. Do not add other scopes as Sign In With Slack only supportsprofile
,email
,openid
.
Enter your Slack 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 Slack from the accordion list to expand and turn Slack Enabled to ON
- Enter your Slack Client ID and Slack Client Secret saved in the previous step
- Click
Save
Add login code to your client app
Make sure you're using the right supabase
client in the following code.
If you're not using Server-Side Rendering or cookie-based Auth, you can directly use the createClient
from @supabase/supabase-js
. If you're using Server-Side Rendering, see the Server-Side Auth guide for instructions on creating your Supabase client.
When your user signs in, call signInWithOAuth() with slack_oidc
as the provider
:
_10async function signInWithSlack() {_10 const { data, error } = await supabase.auth.signInWithOAuth({_10 provider: 'slack_oidc',_10 })_10}
For a PKCE flow, for example in Server-Side Auth, you need an extra step to handle the code exchange. When calling signInWithOAuth
, provide a redirectTo
URL which points to a callback route. This redirect URL should be added to your redirect allow list.
In the browser, signInWithOAuth
automatically redirects to the OAuth provider's authentication endpoint, which then redirects to your endpoint.
_10await supabase.auth.signInWithOAuth({_10 provider,_10 options: {_10 redirectTo: `http://example.com/auth/callback`,_10 },_10})
At the callback endpoint, handle the code exchange to save the user session.
Create a new file at app/auth/callback/route.ts
and populate with the following:
When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:
_10async function signOut() {_10 const { error } = await supabase.auth.signOut()_10}