Skip to content

Commit f2d0d29

Browse files
Add docs for Vercel provider (#2837)
Co-authored-by: Sarah Soutoul <[email protected]>
1 parent 5009be4 commit f2d0d29

File tree

4 files changed

+78
-0
lines changed

4 files changed

+78
-0
lines changed

docs/guides/configure/auth-strategies/social-connections/all-providers.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,12 @@ Clerk provides a wide range of social providers to ease your user's sign-up and
138138

139139
---
140140

141+
- [Vercel](/docs/guides/configure/auth-strategies/social-connections/vercel)
142+
- Add Vercel as an authentication provider for your Clerk app.
143+
- ![](/docs/images/logos/auth_providers/vercel.svg)
144+
145+
---
146+
141147
- [X/Twitter v2](/docs/guides/configure/auth-strategies/social-connections/x-twitter)
142148
- Add X (Twitter v2) as an authentication provider for your Clerk app.
143149
- ![](/docs/images/logos/auth_providers/x-twitter.svg)
Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
---
2+
title: Add Vercel as a social connection
3+
description: Learn how to allow users to sign up and sign in to your Clerk app with their Vercel account using OAuth.
4+
5+
---
6+
7+
<TutorialHero
8+
beforeYouStart={[
9+
{
10+
title: "A Clerk app is required.",
11+
link: "/docs/getting-started/quickstart/setup-clerk",
12+
icon: "clerk",
13+
},
14+
{
15+
title: "A Vercel account is required.",
16+
link: "https://vercel.com/signup",
17+
icon: "user-circle",
18+
},
19+
]}
20+
/>
21+
22+
Enabling OAuth with [Vercel](https://vercel.com/docs/sign-in-with-vercel) allows your users to sign up and sign in to your Clerk app with their Vercel account.
23+
24+
## Configure for your development instance
25+
26+
For _development instances_, Clerk uses preconfigured shared OAuth credentials and redirect URIs—no other configuration is needed.
27+
28+
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/~/user-authentication/sso-connections) page.
29+
1. Select **Add connection** and select **For all users**.
30+
1. In the **Choose provider** dropdown, select **Vercel**.
31+
1. Select **Add connection**.
32+
33+
## Configure for your production instance
34+
35+
For _production instances_, you must provide custom credentials.
36+
37+
To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/~/user-authentication/sso-connections) and one for your [Vercel team settings](https://vercel.com/account).
38+
39+
<Steps>
40+
### Enable Vercel as a social connection in Clerk
41+
42+
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/~/user-authentication/sso-connections) page.
43+
1. Select **Add connection** and choose **For all users**.
44+
1. In the **Choose provider** dropdown, select **Vercel**.
45+
1. Ensure that both **Enable for sign-up and sign-in** and **Use custom credentials** are toggled on.
46+
1. Save the **Authorization Callback URL** somewhere secure. Keep the modal and page open.
47+
48+
### Create a Vercel app
49+
50+
1. In your [Vercel dashboard](https://vercel.com), navigate to your team's **Settings** tab.
51+
1. Scroll down and select **Apps**, then select **Create**.
52+
1. Enter a **Name** and **Slug** for your app. Optionally, upload a logo.
53+
1. Select **Save**.
54+
1. Save the **Client ID** somewhere secure.
55+
1. Scroll to **Authorization Callback URLs** and add the Authorization Callback URL you saved from the Clerk Dashboard.
56+
1. Navigate to the **Authentication** tab and under **Client Authentication Methods**, select the appropriate method for your app. For server-side applications, `client_secret_basic` or `client_secret_post` are recommended.
57+
1. Navigate to the **Permissions** tab and enable the required scopes: `openid`, `email`, `profile`, and `offline_access`.
58+
1. Select **Generate** to create a client secret. Save the **Client Secret** somewhere secure.
59+
1. Select **Save**.
60+
61+
### Set the Client ID and Client Secret in the Clerk Dashboard
62+
63+
<Include src="_partials/authentication/social-connections/set-client-id-secret" />
64+
65+
### Test your connection
66+
67+
<Include src="_partials/authentication/social-connections/test-your-connection" />
68+
</Steps>
Lines changed: 3 additions & 0 deletions
Loading

scripts/build-docs.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -204,6 +204,7 @@ async function main() {
204204
'guides/configure/auth-strategies/social-connections/twitter.mdx': ['doc-not-in-manifest'],
205205
'guides/configure/auth-strategies/social-connections/x-twitter.mdx': ['doc-not-in-manifest'],
206206
'guides/configure/auth-strategies/social-connections/xero.mdx': ['doc-not-in-manifest'],
207+
'guides/configure/auth-strategies/social-connections/vercel.mdx': ['doc-not-in-manifest'],
207208
'guides/development/upgrading/upgrading-from-v2-to-v3.mdx': ['doc-not-in-manifest'],
208209
'guides/organizations/create-orgs-for-users.mdx': ['doc-not-in-manifest'],
209210
'getting-started/quickstart/setup-clerk.mdx': ['doc-not-in-manifest'],

0 commit comments

Comments
 (0)