Auth

Part Five: Google OAuth

About

How to add Google OAuth Logins to your Supabase Application.

Watch

Logging in with external OAuth providers

Connecting social logins such as Google, GitHub, or Facebook couldn't be easier. In this guide we'll walk you through the process of connecting Google, but the process is basically the same for all of the providers which includes: Azure, Bitbucket, GitHub, GitLab, Facebook, and Google.

First you'll need to create a Google project inside their cloud console, in other providers they may refer to this as an "app" and is usually available on the company's developer portal.

Create a new Google Project inside cloud console

Once you have a project, type "OAuth" into the search bar and open up "OAuth Consent Screen"

Open the OAuth consent screen

Select 'External' and proceed to fill out the rest of the form fields

Select External on the OAuth form

Next open up Credentials page on the left

Open up Credentials page

And click to create a new set of credentials, select OAuth client ID as the option

Create new OAuth client id credentials

Now choose Web Application (assuming you're creating a web app) and in the Authorized redirect URI section you need to add: https://<your-ref>.supabase.co/auth/v1/callback. You can find your Supabase URL in Settings > API inside the Supabase dashboard.

Add your redirect URI

Now you can grab the client ID and secret from the popup, and insert them into the Google section inside the Supabase dashboard in Auth > Settings:

take client id and secret

insert client id and secret into Supabase dashboard in auth > auth

Hit save. Now you should be able to navigate in the browser to:


_10
https://<your-ref>.supabase.co/auth/v1/authorize?provider=google

And log in to your service using any Google or Gmail account.

You can additionally add a query parameter redirect_to= to the end of the URL for example:


_10
https://<your-ref>.supabase.co/auth/v1/authorize?provider=google&redirect_to=http://localhost:3000/welcome

But make sure any URL you enter here is on the same host as the site url that you have entered on the Auth > Settings page on the Supabase dashboard. (There is additional functionality coming soon, where you'll be able to add additional URLs to the allow list).

If you want to redirect the user to a specific page in your website or app after a successful authentication.

You also have the option of requesting additional scopes from the OAuth provider. Let's say for example you want the ability to send emails on behalf of the user's gmail account. You can do this by adding the query parameter scopes, like:


_10
https://<your-ref>.supabase.co/auth/v1/authorize?provider=google&https://www.googleapis.com/auth/gmail.send

Alternatively, if you're using the supabase-js client library, you can call the signInWithOAuth() method:


_10
const { data, error } = await supabase.auth.signInWithOAuth({ provider: 'google' })

Note however that your app will usually have to be verified by Google before you can request advanced scopes such as this.

The only thing left to implement is the UI, but if you prefer to use something pre-built, we have a handy Auth Widget, where you can enable/disable whichever auth providers you want to support.

For any support please get in touch at beta at supabase.com or for feature requests open an issue in the backend or frontend repos.

Resources

Next steps