Skip to content

Commit

Permalink
(chore): update dashboard navigation instructions (#1766)
Browse files Browse the repository at this point in the history
Co-authored-by: victoria <[email protected]>
  • Loading branch information
alexisintech and victoriaxyz committed Dec 6, 2024
1 parent 67ba3cb commit 1ea0328
Show file tree
Hide file tree
Showing 165 changed files with 361 additions and 420 deletions.
5 changes: 2 additions & 3 deletions docs/advanced-usage/satellite-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,8 @@ To access authentication state from a satellite domain, users will be transparen

To add a satellite domain:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=domains)
1. In the navigation sidebar, select **Domains**.
1. Select the **Satellite** tab.
1. In the Clerk Dashboard, navigate to the [**Domains**](https://dashboard.clerk.com/last-active?path=domains) page.
1. Select the **Satellites** tab.
1. Select the **Add satellite domain** button and follow the instructions provided.

For the purposes of this guide:
Expand Down
5 changes: 2 additions & 3 deletions docs/advanced-usage/using-proxies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -158,9 +158,8 @@ When using a proxy, all requests to the Frontend API will be made through your d
<Tabs items={["Dashboard", "Backend API"]}>
<Tab>
1. In the Clerk Dashboard, go to the **[Domains](https://dashboard.clerk.com/last-active?path=domains)** page.
1. Navigate to the **Frontend API** section.
1. Select the **Advanced** drop down.
1. In the Clerk Dashboard, navigate to the **[Domains](https://dashboard.clerk.com/last-active?path=domains)** page.
1. In the **Frontend API** section, select the **Advanced** dropdown.
1. In the **Proxy URL** field, enter your proxy URL. The proxy URL must be a valid URL and resolve correctly.
</Tab>

Expand Down
6 changes: 2 additions & 4 deletions docs/authentication/configuration/email-sms-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,7 @@ When editing a template in the Clerk Dashboard, you can insert variables at the

To access the email templates:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=customization/email).
1. In the navigation sidebar, select **Customization > Emails**.
1. In the Clerk Dashboard, navigate to the [**Emails**](https://dashboard.clerk.com/last-active?path=customization/email) page.
1. Select a template to edit.
1. Once you have selected a template, you will be presented with [template operations](#template-operations), the [template settings](#email-template-settings), and [the WYSIWYG editor](#email-wysiwyg-editor).

Expand Down Expand Up @@ -104,8 +103,7 @@ The email WYSIWYG editor text area is intended mainly for authoring content. Tho

To access the SMS templates:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=customization/sms).
1. In the navigation sidebar, select **Customization > SMS**.
1. In the Clerk Dashboard, navigate to the [**SMS**](https://dashboard.clerk.com/last-active?path=customization/sms) page.
1. Select a template to edit. You can also disable certain SMS notifications.
1. A modal will appear that shows you what the template looks like, plus options to toggle the [**Delivered by Clerk**](#delivered-by-clerk) setting or to [request a change to the template](#request-change).

Expand Down
12 changes: 4 additions & 8 deletions docs/authentication/configuration/restrictions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,7 @@ After creating an account, users cannot change their identifier to bypass the al

To enable this feature:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions).
1. In the top navigation, select **Configure**. Then in the sidebar, select **Restrictions**.
1. In the Clerk Dashboard, navigate to the [**Restrictions**](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions) page.
1. In the **Allowlist** section, toggle on **Enable allowlist**.

> [!CAUTION]
Expand All @@ -85,8 +84,7 @@ By adding specific identifiers to the blocklist, users with those identifiers wi

To enable this feature:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions).
1. In the top navigation, select **Configure**. Then in the sidebar, select **Restrictions**.
1. In the Clerk Dashboard, navigate to the [**Restrictions**](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions) page.
1. In the **Blocklist** section, toggle on **Enable blocklist**.

> [!WARNING]
Expand All @@ -107,8 +105,7 @@ For example, if you add `[email protected]` as a blocked email address, it mean
To enable this feature:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions).
1. In the top navigation, select **Configure**. Then in the sidebar, select **Restrictions**.
1. In the Clerk Dashboard, navigate to the [**Restrictions**](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions) page.
1. In the **Restrictions** section, toggle on **Block email subaddresses**.

### Block sign-ups that use disposable email addresses
Expand All @@ -117,6 +114,5 @@ To enable this feature:

To enable this feature:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions).
1. In the top navigation, select **Configure**. Then in the sidebar, select **Restrictions**.
1. In the Clerk Dashboard, navigate to the [**Restrictions**](https://dashboard.clerk.com/last-active?path=user-authentication/restrictions) page.
1. In the **Restrictions** section, toggle on **Block sign-ups that use disposable email addresses**.
11 changes: 4 additions & 7 deletions docs/authentication/configuration/session-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ A user is considered inactive when the application is closed, or when the app st

By default, the inactivity timeout is set to 7 days. You can set a custom inactivity timeout by following these steps:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=sessions) and select your application.
1. In the navigation sidebar, select **Sessions**.
1. In the Clerk Dashboard, navigate to the [**Sessions**](https://dashboard.clerk.com/last-active?path=sessions) page.
1. Toggle on **Inactivity timeout**.
1. Set your desired duration.

Expand All @@ -38,8 +37,7 @@ The duration after which a session will expire and the user will have to sign in

By default, this setting is enabled with a default value of 7 days for all newly created instances. To find this setting and change the value:

1. Navigate to the the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=sessions) and select your application.
1. In the navigation sidebar, select **Sessions**.
1. In the Clerk Dashboard, navigate to the [**Sessions**](https://dashboard.clerk.com/last-active?path=sessions) page.
1. Toggle on **Maximum lifetime**.
1. Set your desired duration.

Expand All @@ -66,10 +64,9 @@ A multi-session application is an application that allows multiple accounts to b

To enable multi-session in your application, you need to configure it in the Clerk Dashboard.

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=sessions) and select your application.
1. In the navigation sidebar, select **Sessions**.
1. In the Clerk Dashboard, navigate to the [**Sessions**](https://dashboard.clerk.com/last-active?path=sessions) page.
1. Toggle on **Multi-session handling**.
1. Select **Save changes**.
1. Select **Save**.

There are two main ways to add the multi-session feature to your application:

Expand Down
26 changes: 9 additions & 17 deletions docs/authentication/configuration/sign-up-sign-in-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Clerk provides various options for configuring a sign-up and sign-i

Clerk provides multiple options for configuring a sign-up and sign-in flow for your application, such as [identifiers](#identifiers) and [authentication strategies](#authentication-strategies). This guide will walk you through each option.

You can modify your authentication options after your application has been created by navigating to the [Clerk Dashboard](https://dashboard.clerk.com/) and selecting the **User & Authentication** dropdown in the navigation sidebar.
You can modify your authentication options after your application has been created by navigating to the [Clerk Dashboard](https://dashboard.clerk.com/) and selecting any of the options under **User & Authentication**.

## Identifiers

Expand All @@ -31,8 +31,7 @@ Choosing **username** as the identifier enables users to sign up without requiri
To update your identifiers after your application has been created:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) and select your application.
1. In the navigation sidebar, select **User & Authentication > Email, phone, username**.
1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page.
1. In the **Contact information** section, you can select **Email address** and **Phone number** as identifiers. In the **Username** section, you can select **Username** as an identifier.

## Authentication strategies
Expand All @@ -56,8 +55,7 @@ The **passwordless** strategy provides a more secure and convenient sign-in meth

To configure authentication strategies:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) and select your application.
1. In the navigation sidebar, select **User & Authentication > Email, phone, username**.
1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page.
1. In the **Authentication strategies** section, toggle on the authentication strategies you would like to enable.

### Passkeys
Expand Down Expand Up @@ -112,8 +110,7 @@ SMS functionality, including SMS OTPs, is restricted to phone numbers from count

Every instance starts off with a default set of enabled SMS country tiers. To tailor it to your needs:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=customization/sms).
1. In the navigation sidebar, select **Customization > SMS**.
1. In the Clerk Dashboard, navigate to the [**SMS**](https://dashboard.clerk.com/last-active?path=customization/sms) page.
1. Select the **Settings** tab.
1. Enable or disable countries as needed.

Expand Down Expand Up @@ -142,8 +139,7 @@ These methods work similarly to their authentication strategy counterparts but a

To configure verification methods:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) and select your application.
1. In the navigation sidebar, select **User & Authentication > Email, phone, username**.
1. In the Clerk Dashboard, navigate to the [**Email, phone, username**](https://dashboard.clerk.com/last-active?path=user-authentication/email-phone-username) page.
1. Select the settings icon next to the identifier, such as **Email address** or **Phone number**, to open the configuration settings.
1. Under the **Verification methods** section, toggle on the verification methods you would like to enable.
1. Select **Continue** to save your changes.
Expand All @@ -160,8 +156,7 @@ Users can link multiple social providers to their account, depending on your app

To enable social connections:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections).
1. In the top navigation, select **Configure**. Then in the sidebar, select **SSO connections**.
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page.
1. Select the **Add connection** button, and select **For all users**.
1. For development instances, simply select the social providers that you would like to enable. For production instances, you'll need to configure credentials for each social provider. See [the social provider's dedicated guide](/docs/authentication/social-connections/overview) to learn how to configure credentials.

Expand All @@ -171,8 +166,7 @@ Clerk provides [Web3 authentication](/docs/users/web3) with either MetaMask or C

To enable Web3 authentication:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/web3) and select your application.
1. In the navigation sidebar, select **User & Authentication > Web3**.
1. In the Clerk Dashboard, navigate to the [**Web3**](https://dashboard.clerk.com/last-active?path=user-authentication/web3) page.
1. Toggle on the Web3 provider. Currently, Clerk supports MetaMask and Coinbase Wallet.

## Multi-factor authentication
Expand All @@ -181,8 +175,7 @@ Clerk supports multi-factor authentication (MFA), also known as two-factor authe

MFA is not available on the new application screen, but it can be enabled in the Clerk Dashboard.

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/multi-factor) and select your application.
1. In the navigation sidebar, select **User & Authentication > Multi-factor**.
1. In the Clerk Dashboard, navigate to the [**Multi-factor**](https://dashboard.clerk.com/last-active?path=user-authentication/multi-factor) page.
1. Toggle on the MFA strategies you would like to enable.

The following MFA strategies are currently available:
Expand All @@ -201,8 +194,7 @@ You can reset a user's MFA by deleting their MFA enrollments. This will remove a

To reset a user's MFA:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/multi-factor).
1. In the top navigation, select **Users**.
1. At the top of the [Clerk Dashboard](https://dashboard.clerk.com/), select **Users**.
1. Select the user from the list.
1. Select the **Reset MFA enrollments** button.

Expand Down
4 changes: 2 additions & 2 deletions docs/authentication/enterprise-connections/easie/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For _development instances_, Clerk uses preconfigured shared credentials and red
For _production instances_, you must provide custom credentials, which involves generating your own **Client ID** and **Client Secret** using your Google Developer account.

To make the setup process easier, it's recommended to keep two browser tabs open: one for your [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/).
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/).

<Steps>
### Enable Google as an EASIE connection
Expand All @@ -67,7 +67,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
1. In the **Authorized redirect URIs** setting, paste the **Redirect URI** value you saved from the Clerk Dashboard.
1. Select **Create**.

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

Once the OAuth client is created in the Google Cloud Console, a modal will open with your **Client ID** and **Client Secret**. Save these values somewhere secure.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ For _development instances_, Clerk uses preconfigured shared credentials and red
For _production instances_, you must provide custom credentials, which involves generating your own **Client ID** and **Client Secret** using your Microsoft Entra ID account.

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

<Steps>
### Enable Microsoft as an EASIE connection
Expand Down Expand Up @@ -105,7 +105,7 @@ To make the setup process easier, it's recommended to keep two browser tabs open
> When your secret expires, your social connection will stop working until you generate a new client secret and add it to your Clerk app.
1. Save the new client secret's **Value** somewhere secure. You'll add this and your client ID to your Clerk app later. Keep this page open.

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

Go back to the Clerk Dashboard, where the modal should still be open, and paste the **Client ID** and **Client Secret** values into the respective fields. Note that if you have any other Microsoft EASIE connections or a [Microsoft social connection](docs/authentication/social-connections/microsoft), this will update the credentials for all of them. Select **Add connection**.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,7 @@ During SAML SSO and after a user has successfully authenticated, the IdP provide

To disable this behavior:

1. Navigate to the [Clerk Dashboard](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections).
1. In the top navigation, select **Configure**. Then in the sidebar, select **SSO connections**.
1. In the Clerk Dashboard, navigate to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page.
1. Select the SAML connection you want to disable the sync for.
1. Select the **Advanced** tab.
1. Toggle off the **Sync user attributes during Sign in** option.
2 changes: 1 addition & 1 deletion docs/authentication/enterprise-connections/saml/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ description: Learn how to allow users to sign up and sign in to your Clerk app w

Enabling single sign-on (SSO) with **Microsoft Azure Entra ID** (formerly [Active Directory](https://learn.microsoft.com/en-us/entra/fundamentals/new-name)) allows your users to sign up and sign in to your Clerk application with their Microsoft account.

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

<Steps>
### Set up an enterprise connection in Clerk
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Clerk supports Enterprise SSO via the SAML protocol, enabling you to create auth

### Create a new enterprise application in your IdP

Create a new application in your IdP. In the next steps, you will configure your IdP with the settings provided by your Service Provider (Clerk), and you will configure Clerk with the settings provided by your IdP. So, you will need to keep both the IdP and Clerk dashboards open.
Create a new application in your IdP. In the next steps, you'll configure your IdP with the settings provided by your Service Provider (Clerk), and configure Clerk with the settings provided by your IdP. Keep both the IdP and Clerk Dashboard open.

### Configure your Identity Provider

Expand Down Expand Up @@ -80,7 +80,7 @@ Clerk supports Enterprise SSO via the SAML protocol, enabling you to create auth
1. In your IdP dashboard, paste the values in the appropriate fields.

> [!TIP]
> If you closed your connection's configuration page in the Clerk Dashboard, you can find it by navigating to the [SSO connections](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page and selecting the settings icon next to the connection you want to configure.
> If you closed the connection's configuration page in the Clerk Dashboard, you can find it by navigating to the [**SSO connections**](https://dashboard.clerk.com/last-active?path=user-authentication/sso-connections) page and selecting the settings icon next to the connection you want to configure.
### Map your IdP's claims to Clerk fields

Expand Down
Loading

0 comments on commit 1ea0328

Please sign in to comment.