Skip to content

Commit

Permalink
Merge branch 'main' into aa/DOCS-366
Browse files Browse the repository at this point in the history
  • Loading branch information
alexisintech authored Jan 10, 2025
2 parents a967251 + a51a58b commit c4fe4cc
Show file tree
Hide file tree
Showing 68 changed files with 705 additions and 741 deletions.
5 changes: 5 additions & 0 deletions docs/_partials/authentication/set-client-id-secret.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
1. Navigate back to the Clerk Dashboard where the modal should still be open. Paste the **Client ID** and **Client Secret** values that you saved into the respective fields.
1. Select **Add connection**.

> [!NOTE]
> If the modal or page is no longer open, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page in the Clerk Dashboard. Select the connection. Under **Use custom credentials**, paste the values into their respective fields.
9 changes: 9 additions & 0 deletions docs/_partials/authentication/test-your-connection.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
The simplest way to test your connection is to visit your Clerk app's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:

- **For development**`https://your-domain.accounts.dev/sign-in`
- **For production**`https://accounts.your-domain.com/sign-in`

1. Sign in with your connection's credentials.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For _development instances_, Clerk uses preconfigured shared credentials and red
> [!WARNING]
> If you already [configured Google as a social provider](/docs/authentication/social-connections/google), you can skip this step. EASIE SSO will automatically use the credentials you configured for your social connection.
For _production instances_, you must provide custom credentials, which involves generating your own **Client ID** and **Client Secret** using your Google Developer account.
For _production instances_, you must provide custom credentials.

To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [Google Cloud Console](https://console.cloud.google.com/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ For _development instances_, Clerk uses preconfigured shared credentials and red
> [!WARNING]
> If you already [configured Microsoft as a social provider](/docs/authentication/social-connections/microsoft), you can skip this step. EASIE SSO will automatically use the credentials you configured for your social connection.
For _production instances_, you must provide custom credentials, which involves generating your own **Client ID** and **Client Secret** using your Microsoft Entra ID account.
For _production instances_, you must provide custom credentials.

To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [Microsoft Azure portal](https://portal.azure.com).

Expand Down
12 changes: 3 additions & 9 deletions docs/authentication/social-connections/apple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
1. Under **Sign in with Apple for Email Communication**, select **Configure**. You'll be redirected to the **Configure Sign in with Apple for Email Communication** page.
1. Next to **Email Sources** at the top of the page, select the plus icon (+) to add a new **Email Source**.
1. In the **Register your email sources** modal that opens, under **Email Addresses**, add the **Email Source for Apple Private Email Relay** value that you saved from the Clerk Dashboard. It should look something like this: `[email protected]`.
1. Select **Next**. The modal will redirect to the **Confirm your email sources** page.
1. Select **Next**. The modal will redirect to the **Confirm your email sources** screen.
1. Select **Register**. The modal will redirect to the **Email Source Registration Complete** screen.
1. Select **Done**.

Expand Down Expand Up @@ -161,13 +161,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
1. Add all the corresponding fields depending on your desired flow. For the **Apple Private Key** file, open it with a text editor and copy/paste the contents.
1. Select **Add connection**.

### Test your OAuth
### Test your connection

The simplest way to test your OAuth is to visit your Clerk app's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:
- **For development** - `https://your-domain.accounts.dev/sign-in`
- **For production** - `https://accounts.your-domain.com/sign-in`
1. Sign in with your Apple account.
<Include src="_partials/authentication/test-your-connection" />
</Steps>
91 changes: 50 additions & 41 deletions docs/authentication/social-connections/bitbucket.mdx
Original file line number Diff line number Diff line change
@@ -1,61 +1,70 @@
---
title: Add Bitbucket as a social connection
description: Learn how to set up social connection with Bitbucket.
description: Learn how to allow users to sign up and sign in to your Clerk app with their Bitbucket account with OAuth.
---

How to set up social connection with Bitbucket
<TutorialHero
beforeYouStart={[
{
title: "A Clerk app is required.",
link: "/docs/quickstarts/setup-clerk",
icon: "clerk",
},
{
title: "A Bitbucket account is required.",
link: "https://bitbucket.org/account/signup",
icon: "user-circle",
}
]}
>
- Use Bitbucket to authenticate users with OAuth
</TutorialHero>

## Overview
Enabling OAuth with [Bitbucket](https://developer.atlassian.com/cloud/bitbucket/oauth-2) allows your users to sign up and sign in to your Clerk application with their Bitbucket account.

Adding social connection with Bitbucket to your app with Clerk is done in a few steps - you will need to populate the **Client ID**, **Client Secret** and **Redirect URI** in your instance settings.
## Configure for your development instance

To make the development flow as smooth as possible, Clerk uses preconfigured shared OAuth credentials and redirect URIs for development instances - no other configuration is needed.
For _development instances_, Clerk uses preconfigured shared OAuth credentials and redirect URIsno other configuration is needed.

For production instances, you will need to generate your own Consumer Key and Consumer Secret using your Bitbucket account.
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page.
1. Select **Add connection** and select **For all users**.
1. In the **Choose provider** dropdown, select **Bitbucket**.
1. Select **Add connection**.

> [!NOTE]
> The purpose of this guide is to help you create a Bitbucket account and a Bitbucket OAuth Consumer - if you're looking for step-by-step instructions using Clerk to add social connection (OAuth) to your application, follow the [Social connection (OAuth) guide](/docs/authentication/social-connections/oauth).
## Configure for your production instance

## Before you start
For _production instances_, you must provide custom credentials.

- You need to create a Clerk application in the [Clerk Dashboard](https://dashboard.clerk.com/). For more information, see the [setup guide](/docs/quickstarts/setup-clerk).
- You need to have a Bitbucket account. To create one, [click here](https://bitbucket.org/account/signup).
To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [Bitbucket Workspaces](https://bitbucket.org/account/workspaces/) page.

## Configuring Bitbucket social connection
<Steps>
### Enable Bitbucket as a social connection in Clerk

Firstly, you will need to have a Bitbucket workspace.
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page.
1. Select **Add connection** and select **For all users**.
1. In the **Choose provider** dropdown, select **Bitbucket**.
1. Ensure that both **Enable for sign-up and sign-in** and **Use custom credentials** are toggled on.
1. Save the **Callback URL** somewhere secure. Keep the modal and page open.

You can navigate to the [list of all your workspaces](https://bitbucket.org/account/workspaces/) to select an existing workspace or create a new one:
### Create a Bitbucket OAuth Consumer

![Bitbucket workspace listing](/docs/images/authentication-providers/bitbucket/005f4b20222a0641a443f750e24d26fd088324db-3360x1896.png)
1. On a separate page, go to the [Bitbucket Workspaces](https://bitbucket.org/account/workspaces/) page and sign in.
1. Under **Workspaces**, find your workspace and select **Manage**.
1. In the sidebar, scroll down and select **OAuth consumers**.
1. Select **Add consumer**.
1. Complete the required fields. In **Permissions** , under **Account**, select **Email** and **Read**.
1. Select **Save**. You'll be redirected to the **OAuth consumers** page.
1. Select your consumer and save the **Key** and **Secret** values somewhere secure.

From there, click on the desired existing workspace or create a new one, then navigate to:
### Set the Key and Secret in the Clerk Dashboard

**Settings** > **Oauth Consumers**
1. Navigate back to the Clerk Dashboard where the modal should still be open. Paste the **Key** and **Secret** values that you saved into the respective fields.
1. Select **Add connection**.

![Bitbucket OAuth Consumer list](/docs/images/authentication-providers/bitbucket/b072d3a9f269a46468e651646d08522aa253fdaf-3360x1782.png)
> [!NOTE]
> If the modal or page is no longer open, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page in the Clerk Dashboard. Select the connection. Under **Use custom credentials**, paste the values into their respective fields.
You will need to create a consumer if you don't have one already.
### Test your connection

The first important setting for the connection to work is the **Callback URL**. Paste the **Redirect URI** from your Clerk Bitbucket settings in this field:

![OAuth consumer creation](/docs/images/authentication-providers/bitbucket/3c3f5f49188f740839a9e0f348ffe4d34a5300c3-3360x1782.png)

The rest of the form fields (**Name, Description, URL, Privacy Policy URL, EULA URL**) can be set to match your application settings.

The second important setting is the selection of scopes that Clerk should request from Bitbucket upon connecting.

![Bitbucket OAuth Consumer scopes](/docs/images/authentication-providers/bitbucket/65aee792cbde8564897d5f1110caf090789bf532-1304x942.png)

Under **Account**, the **Email** & **Read** scopes should be enabled so that Clerk can use your basic Bitbucket account info when creating your Clerk user.

After saving the Oauth Consumer, Bitbucket will generate a **Consumer Key** and **Consumer Secret** for you. These can be displayed by clicking on the **Consumer** entry in your OAuth Consumer list.

You will need to copy:

- The Bitbucket Client **Key** to the **Client ID** input on Clerk
- The Bitbucket Client **Secret** to the **Client Secret** input on Clerk

![Client ID and Client Secret inputs for Bitbucket connection](/docs/images/authentication-providers/bitbucket/c29fd970821d0746e7637f69bf8f411695638834-1220x784.png)

Congratulations! Social connection with Bitbucket is now configured for your instance.
<Include src="_partials/authentication/test-your-connection" />
</Steps>
22 changes: 5 additions & 17 deletions docs/authentication/social-connections/box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For _development instances_, Clerk uses preconfigured shared OAuth credentials a

## Configure for your production instance

For _production instances_, you must provide custom credentials, which involves generating your own **Client ID** and **Client Secret** using your Box account.
For _production instances_, you must provide custom credentials.

To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [Box Developer Console](https://app.box.com/developers/console).

Expand All @@ -54,25 +54,13 @@ To make the setup process easier, it's recommended to keep two browser tabs open
1. In the list of authentication methods, select **User Authentication (OAuth 2.0)**.
1. Select **Create App**. You'll be redirected to the app's **Configuration** page.
1. In the **OAuth 2.0 Redirect URIs** section, paste the **Redirect URI** value you saved from the Clerk Dashboard.
1. In the **OAuth 2.0 Credentials** section, copy the **Client ID** and **Client Secret** somewhere secure. You'll need them to connect your Box app to your Clerk app.
1. In the **OAuth 2.0 Credentials** section, save the **Client ID** and **Client Secret** somewhere secure.

### Set the Client ID and Client Secret in the Clerk Dashboard

1. Navigate back to the Clerk Dashboard where the modal should still be open. Paste the **Client ID** and **Client Secret** values into the respective fields.
1. Select **Add connection**.
<Include src="_partials/authentication/set-client-id-secret" />

> [!NOTE]
> If the modal or page is not still open, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page in the Clerk Dashboard. Select the **Box** connection. Under **Use custom credentials**, you can paste the **Client ID** and **Client Secret** into their respective fields.
### Test your connection

### Test your OAuth

The simplest way to test your OAuth is to visit your Clerk app's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:

- **For development**`https://your-domain.accounts.dev/sign-in`
- **For production**`https://accounts.your-domain.com/sign-in`

1. Sign in with your Box account.
<Include src="_partials/authentication/test-your-connection" />
</Steps>
24 changes: 6 additions & 18 deletions docs/authentication/social-connections/coinbase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For _development instances_, Clerk uses preconfigured shared OAuth credentials a

## Configure for your production instance

For _production instances_, you must provide custom credentials which involves generating your own **Client ID** and **Client Secret** using your Coinbase account.
For _production instances_, you must provide custom credentials.

To make the setup process easier, it's recommended to keep two browser tabs open: one for the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) and one for your [Coinbase's Developer Platform](https://portal.cdp.coinbase.com).

Expand All @@ -51,28 +51,16 @@ To make the setup process easier, it's recommended to keep two browser tabs open
> [!NOTE]
> Coinbase automatically creates a default project for you named `Project 1`. Select the icon next to the project name to rename it.
1. In your [Coinbase Developer Platform project dashboard](https://portal.cdp.coinbase.com/projects), navigate to the **API keys** tab.
1. In your [Coinbase Developer Platform project dashboard](https://portal.cdp.coinbase.com/projects), select the **API keys** tab.
1. Select **OAuth**, then select **Create client**.
1. Complete the required fields. In **Redirect URIs**, paste the **Redirect URI** you saved from the Clerk Dashboard.
1. Select **Create client**. The page will refresh and you should see the **Client ID** and **Client Secret** in the **OAuth** section. Save both values somewhere secure.
1. Select **Create client**. The page will refresh and you should see the **Client ID** and **Client Secret**. Save these values somewhere secure.

### Set the Client ID and Client Secret in the Clerk Dashboard

1. Navigate back to the Clerk Dashboard where the modal should still be open. Paste the **Client ID** and **Client Secret** values that you saved into the respective fields.
1. Select **Add connection**.
<Include src="_partials/authentication/set-client-id-secret" />

> [!NOTE]
> If the modal or page is not still open, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page in the Clerk Dashboard. Select the **Coinbase** connection. Under **Use custom credentials**, you can paste the **Client ID** and **Client Secret** into their respective fields.
### Test your OAuth

The simplest way to test your OAuth is to visit your Clerk app's [Account Portal](/docs/customization/account-portal/overview), which is available for all Clerk apps out-of-the-box.

1. In the Clerk Dashboard, navigate to the [**Account Portal**](https://dashboard.clerk.com/last-active?path=account-portal) page.
1. Next to the **Sign-in** URL, select **Visit**. The URL should resemble:

- **For development**`https://your-domain.accounts.dev/sign-in`
- **For production**`https://accounts.your-domain.com/sign-in`
### Test your connection

1. Sign in with your Coinbase account.
<Include src="_partials/authentication/test-your-connection" />
</Steps>
Loading

0 comments on commit c4fe4cc

Please sign in to comment.