Skip to content

Commit

Permalink
Align SSO connection pages with Dashboard terminology (#1596)
Browse files Browse the repository at this point in the history
Co-authored-by: victoria <[email protected]>
  • Loading branch information
alexisintech and victoriaxyz authored Oct 4, 2024
1 parent d62c4a5 commit d481ff0
Show file tree
Hide file tree
Showing 45 changed files with 105 additions and 91 deletions.
2 changes: 1 addition & 1 deletion docs/advanced-usage/clerk-idp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Learn how to use Clerk to facilitate Single Sign-On (SSO) with othe
---

> [!WARNING]
> **This feature is not designed for handling authentication directly in your application.** To handle authentication _in your_ application, you can [configure one of the many OAuth providers that Clerk offers](/docs/authentication/social-connections/oauth#configuration), such as Google.
> **This feature is not designed for handling authentication directly in your application.** To handle authentication _in your_ application, you can [configure one of the many social providers that Clerk offers](/docs/authentication/social-connections/oauth#configuration), such as Google.
Clerk can be configured as an identity provider to facilitate Single Sign-On (SSO) with other clients that support the OAuth 2.0 protocol. This feature allows users to sign in to other applications using their Clerk credentials, enabling user information sharing between your Clerk application and external websites.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ When **phone number** is selected as the identifier, a user can sign up with the
Choosing **username** as the identifier enables users to sign up without requiring personal contact information. A username should be from 4 to 64 characters in length and can contain alphanumeric characters, underscores (\_), and dashes (-).

> [!NOTE]
> If you choose not to collect any contact information, you can enable **Username** authentication and later disable it in settings, opting to authenticate only with an OAuth social provider.
> If you choose not to collect any contact information, you can enable **Username** authentication and later disable it in settings, opting to authenticate only with a social provider.
To update your identifiers after your application has been created:

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/azure.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Use Microsoft Entra ID for SAML SSO
title: Add Microsoft Entra ID as a SAML connection
description: Learn how to allow users to sign into your Clerk app with their Microsoft account using SAML SSO.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/custom-provider.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Use a custom Identity Provider for SAML SSO
title: Add a custom Identity Provider as a SAML connection
description: Learn how to integrate an Identity Provider with Clerk using SAML SSO.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/google.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Use Google Workspace for SAML SSO
title: Add Google Workspace as a SAML connection
description: Learn how to integrate Google Workspace with Clerk using SAML SSO.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/saml/okta.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Use Okta Workforce for SAML SSO
title: Add Okta Workforce as a SAML connection
description: Learn how to integrate Okta Workforce with Clerk using SAML SSO.
---

Expand Down
10 changes: 5 additions & 5 deletions docs/authentication/social-connections/account-linking.mdx
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
---
title: Account Linking
description: Learn how Clerk handles account linking and manages unverified email addresses from OAuth providers.
description: Learn how Clerk handles account linking and manages unverified email addresses from social providers.
---

Account Linking is a process used by Clerk to ensure a smooth sign-in and sign-up experience using both OAuth and other methods (e.g. username/password). By using the "email address" as the common identifier, Clerk aims to merge accounts whenever possible. This mechanism is triggered when an OAuth provider returns an email address that matches an existing account, assuming a single owner for each email address.
Account Linking is a process used by Clerk to ensure a smooth sign-in and sign-up experience using both OAuth and other methods (e.g. username/password). By using the "email address" as the common identifier, Clerk aims to merge accounts whenever possible. This mechanism is triggered when a social provider returns an email address that matches an existing account, assuming a single owner for each email address.

## How it works

When a user attempts to sign in or sign up, Clerk first checks the email address provided. If that email address comes from an OAuth provider such as Google or Facebook, Clerk's behavior varies. It considers two main factors: the verification status of the email address, and whether an account with that email address already exists in Clerk's system. Based on these factors, Clerk will attempt to link the OAuth account with any existing Clerk account that shares the same email address.
When a user attempts to sign in or sign up, Clerk first checks the email address provided. If that email address comes from a social provider such as Google or Facebook, Clerk's behavior varies. It considers two main factors: the verification status of the email address, and whether an account with that email address already exists in Clerk's system. Based on these factors, Clerk will attempt to link the OAuth account with any existing Clerk account that shares the same email address.

In the following sections, we'll look at the different scenarios that can occur during this process and explain how Clerk handles each one.

![Flow chart of the account linking process in various scenarios](/docs/images/authentication/account-linking-flow-oauth.webp)

### Email address is verified in both OAuth and Clerk

In this scenario, when a user with a verified email address signs in using an OAuth provider that returns a matching verified email address, Clerk links the OAuth account to the existing account and signs the user in. This even applies to password-protected accounts, as the OAuth sign-in process automatically bypasses password verification.
In this scenario, when a user with a verified email address signs in using a social provider that returns a matching verified email address, Clerk links the OAuth account to the existing account and signs the user in. This even applies to password-protected accounts, as the OAuth sign-in process automatically bypasses password verification.

### Email address is verified in Clerk but not in OAuth

In this scenario, when a user with a verified email address at Clerk signs in using an OAuth provider that returns a matching but unverified email address, Clerk will initiate a verification process. Once the email address is verified, the OAuth account is linked to the existing one, and the user is signed in.
In this scenario, when a user with a verified email address at Clerk signs in using a social provider that returns a matching but unverified email address, Clerk will initiate a verification process. Once the email address is verified, the OAuth account is linked to the existing one, and the user is signed in.

### Email address is not verified in Clerk and not in OAuth

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/apple.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OAuth with Apple
title: Add Apple as a social connection
description: Learn how to allow users to sign into your Clerk app with their Apple ID using OAuth.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/atlassian.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Atlassian
title: Add Atlassian as a social connection
description: Learn how to set up social connection with Atlassian.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/bitbucket.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Bitbucket
title: Add Bitbucket as a social connection
description: Learn how to set up social connection with Bitbucket.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/box.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Box
title: Add Box as a social connection
description: Learn how to set up social connection with Box.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/coinbase.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Coinbase
title: Add Coinbase as a social connection
description: Learn how to set up social connection with Coinbase.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/custom-provider.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OAuth with a custom auth provider
title: Add a custom OAuth provider as a social connection
description: Configure a custom OpenID Connect (OIDC) compatible authentication provider for your Clerk application.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/discord.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Discord
title: Add Discord as a social connection
description: Learn how to set up social connection with Discord.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/dropbox.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Dropbox
title: Add Dropbox as a social connection
description: Learn how to set up social connection with Dropbox.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/facebook.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Facebook
title: Add Facebook as a social connection
description: Learn how to set up social connection with Facebook.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/github.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: GitHub
title: Add GitHub as a social connection
description: Learn how to set up social connection with GitHub.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/gitlab.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: GitLab
title: Add GitLab as a social connection
description: Learn how to set up social connection with GitLab.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/google.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Google
title: Add Google as a social connection
description: Learn how to set up social connection with Google.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/hubspot.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: HubSpot
title: Add HubSpot as a social connection
description: Learn how to setup social connection with HubSpot.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/huggingface.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OAuth with Hugging Face
title: Add Hugging Face as a social connection
description: Learn how to allow users to sign in to your Clerk app with their Hugging Face account using OAuth.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/line.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: LINE
title: Add LINE as a social connection
description: Learn how to set up social connection with LINE.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/linear.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Linear
title: Add Linear as a social connection
description: Learn how to set up social connection with Linear.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/linkedin-oidc.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OAuth with LinkedIn Open ID Connect (OIDC)
title: Add LinkedIn Open ID Connect (OIDC) as a social connection
description: Learn how to allow users to sign into your Clerk app with their LinkedIn Open ID Connect account using OAuth.
---

Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/social-connections/microsoft.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: OAuth with Microsoft Azure Entra ID
title: Add Microsoft Azure Entra ID as a social connection
description: Learn how to allow users to sign into your Clerk app with their Microsoft account using OAuth.
---

Expand Down Expand Up @@ -137,5 +137,5 @@ In _production instances_, you must provide custom credentials, which includes g
---

- [Account Linking](/docs/authentication/social-connections/account-linking)
- Learn how Clerk handles account linking and manages unverified email addresses from OAuth providers.
- Learn how Clerk handles account linking and manages unverified email addresses from social providers.
</Cards>
2 changes: 1 addition & 1 deletion docs/authentication/social-connections/notion.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Notion
title: Add Notion as a social connection
description: Learn how to set up social connection with Notion.
---

Expand Down
Loading

0 comments on commit d481ff0

Please sign in to comment.