Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Core 1: Long Lived Backport Target #922

Draft
wants to merge 4 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 1 addition & 3 deletions docs/account-portal/custom-redirects.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Customizing your Account Portal redirect
title: Customizing your Account Portal redirects
description: Customize where your users are redirected to after they sign in or sign up.
---

# Customizing your Account Portal redirects

After a user signs in or signs up, Clerk automatically redirects users back to your application by appending a `redirect_url` query param on the Account Portal page. However, Clerk provides various options for you to customize where your users are redirected to.

## Environment variables
Expand Down
2 changes: 0 additions & 2 deletions docs/account-portal/direct-links.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Direct links
description: Learn how to share direct links to your Account Portal pages, and how to set up fallback redirects.
---

# Direct links

## Redirect URL

If a user accesses an Account Portal page *directly*, the `redirect_url` query param will not be present, so the user cannot be redirected back to your application once they are finished with their Account Portal flow. To prevent this, it is recommend that you always specify the redirect in the link when sharing it.
Expand Down
2 changes: 0 additions & 2 deletions docs/account-portal/disable-account-portal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Disabling the Account Portal
description: Learn how to disable the Account Portal.
---

# Disabling the Account Portal

If you would like to disable the Account Portal, in the Clerk Dashboard, go to the **[Account Portal](https://dashboard.clerk.com/last-active?path=account-portal)** page and then open the **Danger** tab. Please ensure that you set up an authentication flow for your users via the instructions below first, as applying this setting will immediately result in a 404 for all Account Portal pages.

<Callout type="danger">
Expand Down
2 changes: 0 additions & 2 deletions docs/account-portal/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Getting started with the Account Portal
description: The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
---

# Getting started with the Account Portal

To integrate the Account Portal into your application, simply follow one of our [quickstart guides](/docs/quickstarts/overview).

Once your application is set up, all you have to do is fire it up. Clerk will automatically redirect your users to the Account Portal sign-in/sign-up pages. Once a user has successfully authenticated themself, they will be automatically redirected back to your application with an active session.
Expand Down
4 changes: 1 addition & 3 deletions docs/account-portal/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Account Portal Overview
title: Account portal overview
description: The Account Portal offers a comprehensive solution for managing user authentication and profile management in your web application and is the fastest way to add Clerk's authentication to your application with minimal code required.
---

# Account portal overview

The Account Portal in Clerk is a powerful feature that allows you to streamline the sign-in, sign-up, and profile management experience for your users, without having to build your own components or host your own pages.

<Images
Expand Down
2 changes: 0 additions & 2 deletions docs/account-portal/user-profile-org-profile.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: User & Organization Pages
description: In addition to the sign-in/sign-up pages, the Account Portal also provides the User Profile, Organization Profile and Create Organization flow out of the box.
---

# User & Organization Pages

In addition to the sign-in/sign-up pages, the Account Portal also provides the User Profile, Organization Profile, and Create Organization pages out of the box.

You can use Clerk's Control Components to navigate your users to the appropriate page.
Expand Down
2 changes: 0 additions & 2 deletions docs/advanced-usage/clerk-idp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Use Clerk as an OAuth 2 Provider
description: Learn how to use Clerk to facilitate Single Sign-On (SSO) with other clients that support the OAuth 2.0 protocol.
---

# Use Clerk as an OAuth 2 Provider

Learn how to use Clerk to facilitate Single Sign-On (SSO) with other clients that support the OAuth 2.0 protocol.

<Images
Expand Down
2 changes: 0 additions & 2 deletions docs/advanced-usage/satellite-domains.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Adding satellite domains
description: Learn how to share sessions across different domains by adding satellite domains to your application.
---

# Adding satellite domains

Clerk supports sharing sessions across different domains by adding one or many satellite domains to an application.

Your "primary" domain is where the authentication state lives, and satellite domains are able to securely read that state from the primary domain, enabling a seamless authentication flow across domains.
Expand Down
2 changes: 0 additions & 2 deletions docs/advanced-usage/using-proxies.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Proxying the Clerk Frontend API
description: Learn how to proxy the Clerk Frontend API through your domain.
---

# Proxying the Clerk Frontend API

Clerk supports two configuration methods for connecting to the Clerk Frontend API: CNAME and Proxy.

The recommended way to connect to the Clerk Frontend API is to [set up CNAME records and use DNS](/docs/deployments/overview). However, if you're unable to use this approach, or would like more control over your integration with Clerk, you can use a proxy.
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/configuration/email-sms-templates.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Email and SMS templates
description: Learn how to configure the theming of Clerk-sent emails and SMS messages.
---

# Email and SMS templates

Clerk provides a templating system that allows you to customize the default system email and SMS messages sent during authentication flows.

The template editor enables you to change the wording and styling so that it is more consistent with your own branding.
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/configuration/restrictions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Restrictions
description: Learn how to manage user access to your application by configuring Clerk's access restrictions.
---

# Restrictions

Clerk provides restriction options that give you enhanced control over who can access your application. These options enable you to limit sign-ups or prevent accounts with specific [identifiers](/docs/authentication/configuration/sign-up-sign-in-options#identifiers), such as email address, from accessing your application.

There are two main types of restrictions available:
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/configuration/session-options.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Session options
description: Clerk provides session management options for fine-tuning user visits to your application.
---

# Session options

Clerk provides session management options for fine-tuning user visits to your application, including options for session lifetime, multi-session handling, and session token customization.

## Session lifetime
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Sign-up and sign-in options
description: Clerk provides various options for setting up a sign-up and sign-in flow.
---

# Sign-up and sign-in options

Clerk provides various options for setting up a sign-up and sign-in flow. When a new application is created, you will be presented with the following application configuration screen:

<Images
Expand Down
4 changes: 1 addition & 3 deletions docs/authentication/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Sign-up & Sign-in Overview
title: Overview
description: Learn how to configure authentication and user management for your Clerk application.
---

# Overview

Clerk supports multiple authentication strategies so that you can implement the strategy that makes sense for *your* users. You can use Clerk's [Account Portal](/docs/account-portal/overview), [pre-built components](/docs/components/overview), or [build your own custom flows](/docs/custom-flows/overview).


Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/account-linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Account Linking
description: Learn how Clerk handles account linking during SAML SSO.
---

# Account Linking

Account Linking is a process that Clerk uses to ensure a smooth sign-in and sign-up experience using SAML SSO and other methods (e.g. username/password). By using the email address as the common identifier, Clerk automatically attempts to link accounts whenever possible. Account linking triggers when a SAML provider returns an email address that matches an existing account, assuming a single owner for each email address.

## How it works
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/authentication-flows.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: SAML SSO authentication flows
description: Learn about the SAML SSO authentication flows.
---

# SAML SSO authentication flows

The SAML protocol supports two different methods in order to start an SSO flow: SP-initiated and IdP-initiated. This guide will explore the differences between the two.

## SP-initiated flow (recommended)
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/azure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Use Microsoft Azure AD for SAML SSO
description: Learn how to integrate Microsoft Azure AD with Clerk using SAML SSO.
---

# Use Microsoft Azure AD for SAML SSO

<TutorialHero
beforeYouStart={[
{
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/custom-provider.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Use a custom Identity Provider for SAML SSO
description: Learn how to integrate an Identity Provider with Clerk using SAML SSO.
---

# Use a custom Identity Provider for SAML SSO

<TutorialHero
beforeYouStart={[
{
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Use Google Workspace for SAML SSO
description: Learn how to integrate Google Workspace with Clerk using SAML SSO.
---

# Use Google Workspace for SAML SSO

<TutorialHero
beforeYouStart={[
{
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/okta.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Use Okta Workforce for SAML SSO
description: Learn how to integrate Okta Workforce with Clerk using SAML SSO.
---

# Use Okta Workforce for SAML SSO

<TutorialHero
beforeYouStart={[
{
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/saml/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Enterprise SSO via SAML
description: Clerk supports Enterprise SSO via the SAML protocol so that you can create authentication strategies for Identity Providers, such as Okta.
---

# Enterprise SSO via SAML

Clerk supports Enterprise SSO via the SAML protocol, enabling you to create authentication strategies for an Identity Provider (IdP). With Enterprise SSO, users can sign in seamlessly using their IdP's credentials and have their user data synchronized with Clerk. You can learn more about the process in the [SAML SSO authentication flows](/docs/authentication/saml/authentication-flows) and [Account linking](/docs/authentication/saml/account-linking) guides, or you can jump straight into integrating an IdP with Clerk. Currently, Clerk offers direct integrations with [Microsoft Azure AD](/docs/authentication/saml/azure), [Google Workspace](/docs/authentication/saml/google), and [Okta Workforce](/docs/authentication/saml/okta) as IdPs. However, you can also [integrate with any other IdP](/docs/authentication/saml/custom-provider) that supports the SAML protocol.

## Sync user attributes during sign in
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/account-linking.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Account Linking
description: Learn how Clerk handles account linking and manages unverified email addresses from OAuth providers.
---

# Account Linking

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.

## How it works
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/apple.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Apple
description: Learn how to set up social connection with Apple.
---

# Apple

How to set up social connection with Apple

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/atlassian.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Atlassian
description: Learn how to set up social connection with Atlassian.
---

# Atlassian

How to set up social connection with Atlassian

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/bitbucket.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Bitbucket
description: Learn how to set up social connection with Bitbucket.
---

# Bitbucket

How to set up social connection with Bitbucket

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/box.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Box
description: Learn how to set up social connection with Box.
---

# Box

How to set up social connection with Box

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/coinbase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Coinbase
description: Learn how to set up social connection with Coinbase.
---

# Coinbase

How to set up social connection with Coinbase

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/discord.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Discord
description: Learn how to set up social connection with Discord.
---

# Discord

How to set up social connection with Discord

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/dropbox.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Dropbox
description: Learn how to set up social connection with Dropbox.
---

# Dropbox

How to set up social connection with Dropbox

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/facebook.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Facebook
description: Learn how to set up social connection with Facebook.
---

# Facebook

How to set up social connection with Facebook

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/github.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: GitHub
description: Learn how to set up social connection with GitHub.
---

# GitHub

How to set up social connection with GitHub

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/gitlab.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: GitLab
description: Learn how to set up social connection with GitLab.
---

# GitLab

How to set up social connection with GitLab

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/google.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Google
description: Learn how to set up social connection with Google.
---

# Google

How to set up social connection with Google

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/hubspot.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: HubSpot
description: Learn how to setup social connection with HubSpot.
---

# HubSpot

How to set up social connection with HubSpot

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/line.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: LINE
description: Learn how to set up social connection with LINE.
---

# LINE

How to set up social connection with LINE

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/linear.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Linear
description: Learn how to set up social connection with Linear.
---

# Linear

How to set up social connection with Linear

## Overview
Expand Down
4 changes: 1 addition & 3 deletions docs/authentication/social-connections/linkedin-oidc.mdx
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
---
title: Set up a social connection with LinkedIn OpenID Connect
title: LinkedIn OpenID Connect
description: Learn how to set up a social connection with LinkedIn in your Clerk application.
---

# LinkedIn OpenID Connect

<TutorialHero
beforeYouStart={[
{
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/linkedin.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: LinkedIn (Deprecated)
description: Learn how to set up social connection with LinkedIn.
---

# LinkedIn (Deprecated)

<Callout type="danger">
This page is now deprecated. Please see the new [guide](/docs/authentication/social-connections/linkedin-oidc) on how to set up a social connection with LinkedIn.
</Callout>
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/microsoft.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Microsoft
description: Learn how to set up social connection with Microsoft.
---

# Microsoft

How to set up social connection with Microsoft Azure Active Directory

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/notion.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Notion
description: Learn how to set up social connection with Notion.
---

# Notion

How to set up social connection with Notion

## Overview
Expand Down
2 changes: 0 additions & 2 deletions docs/authentication/social-connections/oauth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: Social connections (OAuth)
description: Learn how to effortlessly add social connections to your application using popular OAuth providers like Google, Facebook, Github and more.
---

# Social connections (OAuth)

Clerk makes it easy to add social connection capabilities to your application. With social connections, users gain frictionless access to your application by using their existing credentials from an OAuth provider (Google, Facebook, X/Twitter, etc.) without having to go through complicated registration flows. Social connections are designed to simplify the sign-up and sign-in process for the end-user, resulting in higher conversion rates, a streamlined user data collection flow, and an overall better user experience.

<Callout type="info">
Expand Down
Loading