Files
mintlify__docs/guides/auth0.mdx
mintlify[bot] 13feb4b38a docs: apply sentence case to two headings/labels for style consistency (#6308)
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
2026-06-26 16:50:00 -07:00

59 lines
3.5 KiB
Plaintext

---
title: "Using Auth0 with the OAuth handshake"
description: "Configure Auth0 as your OAuth provider for Mintlify documentation authentication, including application setup, callback URLs, and token flow."
keywords: ["Auth0", "OAuth flow"]
---
<Note>
**Security disclaimer**: While we provide this guide to help you integrate Auth0 with Mintlify, consult with your security team before implementing any authentication solution. Mintlify is not responsible for any security issues that may arise from your specific implementation.
</Note>
## Overview
This guide walks you through setting up Auth0 as an authentication provider for your Mintlify documentation. By the end, your users can log in to your documentation using their Auth0 credentials.
<Steps>
<Step title="Create a regular web application in Auth0">
Log in to your Auth0 dashboard and navigate to **Applications** > **Applications**. Click **Create Application**, give your application a name (for example, "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**.
<Frame>![Creating a new application in Auth0](/images/guides/auth0/auth0-create-application.png)</Frame>
</Step>
<Step title="Get client information">
After you create your application, Auth0 opens the application settings page, where you'll find the credentials needed for the OAuth integration:
<Frame>![Auth0 client settings page](/images/guides/auth0/auth0clientsettings.png)</Frame>
Make note of the following information:
- **Domain**: This is your Auth0 tenant domain (for example, `your-tenant.auth0.com`)
- **Client ID**: The public identifier for your application
- **Client Secret**: The secret key for your application (keep this secure)
You'll need these values for configuring Mintlify in the next step.
</Step>
<Step title="Set up Mintlify client">
In your Mintlify dashboard, go to **Settings** > **Authentication**. Select **OAuth** as your authentication method to open the OAuth configuration form:
<Frame>![Mintlify OAuth client settings](/images/guides/auth0/mintlifyoauthclientsettings.png)</Frame>
Fill in the form with the following values:
- **Authorization URL**: `https://YOUR_AUTH0_DOMAIN/authorize` (replace `YOUR_AUTH0_DOMAIN` with your actual Auth0 domain from step 2)
- **Client ID**: Enter the Client ID from your Auth0 application
- **Client Secret**: Enter the Client Secret from your Auth0 application
- **Scopes**: Leave blank unless you have custom scopes set in Auth0
- **Token URL**: `https://YOUR_AUTH0_DOMAIN/oauth/token` (replace `YOUR_AUTH0_DOMAIN` with your actual Auth0 domain)
After filling in these details, click **Save changes** to store your OAuth configuration.
</Step>
<Step title="Configure the callback URL">
Mintlify generates a unique Redirect URL that Auth0 needs to recognize for the OAuth flow to work properly.
Copy the Redirect URL from your Mintlify dashboard's Authentication settings:
<Frame>![Mintlify redirect URL](/images/guides/auth0/mintlifyredirecturl.png)</Frame>
Return to your Auth0 application settings page, scroll down to the **Application URIs** section, and paste the Redirect URL into the **Allowed Callback URLs** field:
<Frame>![Auth0 redirect URL configuration](/images/guides/auth0/auth0redirecturl.png)</Frame>
Click **Save Changes** at the bottom of the Auth0 page to apply this configuration.
</Step>
</Steps>