Auth

Login with LinkedIn

To enable LinkedIn Auth for your project, you need to set up a LinkedIn OAuth application and add the application credentials to your Supabase Dashboard.

Overview

Setting up LinkedIn logins for your application consists of 3 parts:

Access your LinkedIn Developer account

LinkedIn Developer Portal

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 LinkedIn from the accordion list to expand and you'll find your Callback URL, you can click Copy to copy it to the clipboard

Create a LinkedIn OAuth app

  • Go to LinkedIn Developer Dashboard.
  • Click on Create App at the top right
  • Enter your LinkedIn Page and App Logo
  • Save your app
  • Click Products from the top menu
  • Look for Sign In with LinkedIn using OpenID Connect and click on Request Access
  • Click Auth from the top menu
  • Add your Redirect URL to the Authorized Redirect URLs for your app section
  • Copy and save your newly-generated Client ID
  • Copy and save your newly-generated Client Secret

Ensure that the appropriate scopes have been added under OAuth 2.0 Scopes at the bottom of the Auth screen.

Required OAuth 2.0 Scopes

Enter your LinkedIn (OIDC) 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 LinkedIn (OIDC) from the accordion list to expand and turn LinkedIn (OIDC) Enabled to ON
  • Enter your LinkedIn (OIDC) Client ID and LinkedIn (OIDC) Client Secret saved in the previous step
  • Click Save

You can also configure the LinkedIn (OIDC) auth provider using the Management API:

1
2
3
4
5
6
7
8
9
10
11
12
13
# Get your access token from https://supabase.com/dashboard/account/tokensexport SUPABASE_ACCESS_TOKEN="your-access-token"export PROJECT_REF="your-project-ref"# Configure LinkedIn (OIDC) auth providercurl -X PATCH "https://api.supabase.com/v1/projects/$PROJECT_REF/config/auth" \  -H "Authorization: Bearer $SUPABASE_ACCESS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "external_linkedin_oidc_enabled": true,    "external_linkedin_oidc_client_id": "your-linkedin-client-id",    "external_linkedin_oidc_secret": "your-linkedin-client-secret"  }'

Add login code to your client app

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

1
2
3
4
5
6
7
8
9
import { createClient } from '@supabase/supabase-js'const supabase = createClient('<your-project-url>', '<sb_publishable_... or anon key>')// ---cut---async function signInWithLinkedIn() {  const { data, error } = await supabase.auth.signInWithOAuth({    provider: 'linkedin_oidc',  })}

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.

1
2
3
4
5
6
7
8
9
10
11
import { createClient, type Provider } from '@supabase/supabase-js';const supabase = createClient('url', 'anonKey')const provider = 'provider' as Provider// ---cut---await supabase.auth.signInWithOAuth({  provider,  options: {    redirectTo: `http://example.com/auth/callback`,  },})

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:

app/auth/callback/route.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
import { NextResponse } from 'next/server'// The client you created from the Server-Side Auth instructionsimport { createClient } from '@/utils/supabase/server'export async function GET(request: Request) {  const { searchParams, origin } = new URL(request.url)  const code = searchParams.get('code')  // if "next" is in param, use it as the redirect URL  let next = searchParams.get('next') ?? '/'  if (!next.startsWith('/')) {    // if "next" is not a relative URL, use the default    next = '/'  }  if (code) {    const supabase = await createClient()    const { error } = await supabase.auth.exchangeCodeForSession(code)    if (!error) {      const forwardedHost = request.headers.get('x-forwarded-host') // original origin before load balancer      const isLocalEnv = process.env.NODE_ENV === 'development'      if (isLocalEnv) {        // we can be sure that there is no load balancer in between, so no need to watch for X-Forwarded-Host        return NextResponse.redirect(`${origin}${next}`)      } else if (forwardedHost) {        return NextResponse.redirect(`https://${forwardedHost}${next}`)      } else {        return NextResponse.redirect(`${origin}${next}`)      }    }  }  // return the user to an error page with instructions  return NextResponse.redirect(`${origin}/auth/auth-code-error`)}

When your user signs out, call signOut() to remove them from the browser session and any objects from localStorage:

1
2
3
4
5
6
7
import { createClient } from '@supabase/supabase-js'const supabase = createClient('<your-project-url>', '<sb_publishable_... or anon key>')// ---cut---async function signOut() {  const { error } = await supabase.auth.signOut()}

LinkedIn Open ID Connect (OIDC)

We will be replacing the LinkedIn provider with a new LinkedIn (OIDC) provider to support recent changes to the LinkedIn OAuth APIs. The new provider utilizes the Open ID Connect standard. In view of this change, we have disabled edits on the LinkedIn provider and will be removing it effective 4th January 2024. Developers with LinkedIn OAuth Applications created prior to 1st August 2023 should create a new OAuth application via the steps outlined above and migrate their credentials from the LinkedIn provider to the LinkedIn (OIDC) provider. Alternatively, you can also head to the Products section and add the newly releaseSign In with LinkedIn using OpenID Connect to your existing OAuth application.

Developers using the Supabase CLI to test their LinkedIn OAuth application should also update their config.toml to make use of the new provider:

1
2
3
4
[auth.external.linkedin_oidc]enabled = trueclient_id = ...secret = ...

Do reach out to support if you have any concerns around this change.

Resources