OAuth providers (Google, GitHub) in Supabase

Introduction

OAuth providers let users sign in using their Google or GitHub accounts. This makes login easy and secure without creating new passwords.

You want users to log in quickly without making new accounts.

You want to use trusted services like Google or GitHub for authentication.

You want to avoid handling passwords and improve security.

You want to allow users to connect their existing Google or GitHub profiles.

You want to simplify user management by relying on OAuth providers.

Syntax

Supabase

supabase.auth.signInWithOAuth({ provider: 'google' })
supabase.auth.signInWithOAuth({ provider: 'github' })

Use the provider name as a string: 'google' or 'github'.

This method opens a popup or redirects to the provider's login page.

Examples

Starts Google OAuth login flow.

Supabase

await supabase.auth.signInWithOAuth({ provider: 'google' })

Starts GitHub OAuth login flow.

Supabase

await supabase.auth.signInWithOAuth({ provider: 'github' })

Starts Google OAuth and redirects user after login.

Supabase

await supabase.auth.signInWithOAuth({ provider: 'google', options: { redirectTo: 'https://yourapp.com/welcome' } })

Sample Program

This code creates a Supabase client and starts the Google OAuth login flow. If there is an error, it logs it. Otherwise, it logs that the login started.

Supabase

import { createClient } from '@supabase/supabase-js'

const supabaseUrl = 'https://xyzcompany.supabase.co'
const supabaseKey = 'public-anonymous-key'
const supabase = createClient(supabaseUrl, supabaseKey)

async function signInWithGoogle() {
  const { data, error } = await supabase.auth.signInWithOAuth({ provider: 'google' })
  if (error) {
    console.error('Error during Google sign-in:', error.message)
  } else {
    console.log('Google sign-in started:', data)
  }
}

signInWithGoogle()

Important Notes

Make sure to set up OAuth credentials in your Supabase project dashboard first.

Redirect URLs must match those configured in Google or GitHub developer settings.

OAuth login opens a popup or redirects the user to the provider's login page.

Summary

OAuth providers let users sign in with Google or GitHub accounts easily.

Use supabase.auth.signInWithOAuth({ provider: 'google' }) or 'github' to start login.

Set up credentials and redirect URLs in Supabase and provider dashboards before using.

Practice

1. What does supabase.auth.signInWithOAuth({ provider: 'google' }) do in a Supabase app?

easy

A. Fetches user data without login

B. Creates a new Google account automatically

C. Deletes the current user session

D. Starts the login process using a Google account

Solution

1. Step 1: Understand the function purpose

   The function signInWithOAuth is used to start OAuth login with a specified provider.

2. Step 2: Identify the provider used

   Here, the provider is 'google', so it triggers Google OAuth login flow.

3. Final Answer:

   Starts the login process using a Google account -> Option D

4. Quick Check:

   OAuth login with Google = Starts login [OK]

Hint: OAuth signInWithOAuth starts login with chosen provider [OK]

Common Mistakes:

• Thinking it creates a new account automatically
• Confusing login start with data fetching
• Assuming it logs out the user

2. Which of the following is the correct syntax to start GitHub OAuth login in Supabase?

easy

A. supabase.auth.signInWithOAuth(provider='github')

B. supabase.auth.signInWithOAuth('github')

C. supabase.auth.signInWithOAuth({ provider: 'github' })

D. supabase.auth.signInWithOAuth({ provider: github })

Solution

1. Step 1: Check the method signature

   The method expects an object with a key named 'provider' and a string value.

2. Step 2: Validate each option

   supabase.auth.signInWithOAuth({ provider: 'github' }) correctly uses an object with provider as string 'github'. Others have syntax errors or missing quotes.

3. Final Answer:

   supabase.auth.signInWithOAuth({ provider: 'github' }) -> Option C

4. Quick Check:

   Correct object syntax with provider string = supabase.auth.signInWithOAuth({ provider: 'github' }) [OK]

Hint: Use object with provider key and string value for OAuth [OK]

Common Mistakes:

• Passing provider as a plain string without object
• Missing quotes around 'github'
• Using wrong parameter syntax

3. Given this code snippet, what will be the output if the user successfully logs in with GitHub?

const { data, error } = await supabase.auth.signInWithOAuth({ provider: 'github' });
console.log(data.session ? 'Logged in' : 'Not logged in');

medium

A. Not logged in

B. Logged in

C. Error thrown

D. Undefined

Solution

1. Step 1: Understand the signInWithOAuth response

   On successful login, data.session contains session info, so it is truthy.

2. Step 2: Evaluate the console.log condition

   The ternary checks if data.session exists; if yes, prints 'Logged in'.

3. Final Answer:

   Logged in -> Option B

4. Quick Check:

   Successful login means data.session truthy = 'Logged in' [OK]

Hint: Check if data.session exists to confirm login success [OK]

Common Mistakes:

• Assuming error is thrown on success
• Confusing data.session with error presence
• Ignoring async/await behavior

4. You wrote this code to start Google OAuth login:

supabase.auth.signInWithOAuth(provider: 'google');

Why does this cause an error?

medium

A. Missing curly braces around the object argument

B. Provider name should be uppercase 'Google'

C. signInWithOAuth does not accept any arguments

D. The method should be called on supabase.auth.user

Solution

1. Step 1: Check the argument syntax

   The method expects an object argument, so it must be wrapped in curly braces.

2. Step 2: Identify the error cause

   Passing provider: 'google' without braces is invalid syntax causing an error.

3. Final Answer:

   Missing curly braces around the object argument -> Option A

4. Quick Check:

   Object argument needs braces = Missing curly braces around the object argument [OK]

Hint: Always wrap provider in curly braces as an object [OK]

Common Mistakes:

• Using provider name with wrong case
• Calling method on wrong object
• Passing provider as plain string

5. You want users to sign in with either Google or GitHub using Supabase OAuth. Which setup step is essential before calling signInWithOAuth?

hard

A. Register your app and set redirect URLs in both Google and GitHub developer consoles

B. Create user accounts manually in Supabase for Google and GitHub users

C. Install Google and GitHub SDKs in your frontend app

D. Set environment variable SUPABASE_OAUTH_SECRET to 'true'

Solution

1. Step 1: Understand OAuth provider requirements

   OAuth providers require you to register your app and configure redirect URLs in their developer portals.

2. Step 2: Confirm necessary setup before login

   Without this setup, OAuth login will fail or redirect incorrectly.

3. Final Answer:

   Register your app and set redirect URLs in both Google and GitHub developer consoles -> Option A

4. Quick Check:

   OAuth setup requires app registration and redirect URLs [OK]

Hint: Always register app and set redirect URLs before OAuth login [OK]

Common Mistakes:

• Thinking manual user creation is needed
• Assuming SDK installation is required
• Setting unrelated environment variables