Set Up SSO with Google Workspace
This feature is only available on the Team and Enterprise Plans. Please contact Sales before doing these steps.
Looking for docs on how to add Single Sign-On support in your Supabase project? Head on over to Single Sign-On with SAML 2.0 for Projects.
Supabase supports single sign-on (SSO) using Google Workspace (formerly known as GSuite).
Step 1: Open the Google Workspace web and mobile apps console
Step 2: Choose to add custom SAML app
From the Add app button in the toolbar choose Add custom SAML app.
Step 3: Fill out app details
The information you enter here is for visibility into your Google Workspace. You can choose any values you like. Supabase as a name works well for most use cases. Optionally enter a description.
Step 4: Download IdP metadata
This is a very important step. Click on DOWNLOAD METADATA and save the file that was downloaded.
It's very important to send this file to your support contact at Supabase to complete the SSO setup process. If you're not sure where to send this file, you can always reach out to Supabase Support.
Important: Make sure the certificate as shown on screen has at least 1 year before it expires. Mark down this date in your calendar so you will be reminded that you need to update the certificate without any downtime for your users.
Step 5: Add service provider details
Fill out these service provider details on the next screen.
| Detail | Value |
|---|---|
| ACS URL | https://alt.supabase.io/auth/v1/sso/saml/acs |
| Entity ID | https://alt.supabase.io/auth/v1/sso/saml/metadata |
| Start URL | https://supabase.com/dashboard |
| Name ID format | PERSISTENT |
| Name ID | Basic Information > Primary email |
Step 6: Configure attribute mapping
Attribute mappings allow Supabase to get information about your Google Workspace users on each login.
A Primary email to email mapping is required. Other mappings shown below are optional and configurable depending on your Google Workspace setup. If in doubt, replicate the same config as shown.
Please share any changes, if any, from this screen with your Supabase support contact.
Step 7: Wait for confirmation
Once you’ve configured the Google Workspace app as shown above, make sure you send the metadata file you downloaded and information regarding the attribute mapping (if any changes are applicable) to your support contact at Supabase.
This information needs to be entered into Supabase before SSO is activated end-to-end.
Wait for confirmation that this information has successfully been added to Supabase. It usually takes us 1 business day to configure this information for you.
Step 8: Configure user access
You can configure which Google Workspace user accounts will get access to Supabase. This is important if you wish to limit access to your software engineering teams.
You can configure this access by clicking on the User access card (or down-arrow). Follow the instructions on screen.
Changes from this step sometimes take a while to propagate across Google’s systems. Wait at least 15 minutes before proceeding to the next step.
Step 9: Test single sign-on
Once you’ve turned on access to Supabase for users in your organization, ask one of those users to help you out in testing the setup.
It often helps to ask them to log out of their Google account and log back in.
Ask them to enter their email address in the Sign in with SSO page.
If sign in is not working correctly, reach out to your support contact at Supabase.