-
Notifications
You must be signed in to change notification settings - Fork 207
Add guide for Auth0 OAuth handshake #554
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
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
--- | ||
title: "Using Auth0 with the OAuth Handshake" | ||
description: "If Auth0 is the source of truth for your user data, you can set up Mintlify as an OAuth client app to authenticate your users." | ||
--- | ||
|
||
<Note> | ||
**Security Disclaimer**: While we provide this guide to help you integrate Auth0 with Mintlify, please 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 will be able to 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 the **Create Application** button, give your application a name (e.g., "Mintlify"), and select **Regular Web Applications** as the application type. Then click **Create**. | ||
|
||
<Frame></Frame> | ||
</Step> | ||
<Step title="Get client information"> | ||
After creating your application, you'll be taken to the application settings page. Here, you'll find the essential credentials needed for the OAuth integration: | ||
|
||
<Frame></Frame> | ||
|
||
Make note of the following information: | ||
- **Domain**: This is your Auth0 tenant domain (e.g., `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="Setup Mintlify client"> | ||
Navigate to your Mintlify Dashboard and go to the **Settings** > **Authentication** section. Select **OAuth** as your authentication method and you'll see the OAuth configuration form: | ||
|
||
<Frame></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 Callback URL"> | ||
Mintlify will generate 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></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></Frame> | ||
|
||
Click **Save Changes** at the bottom of the Auth0 page to apply this configuration. | ||
</Step> | ||
</Steps> |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we want to add this to the nav? I can help make that decision, but just wanted to ask if it was intentionally left out?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was leaning against it because the Auth0 setup could differ widely depending on a customers' setup so want to avoid having this shared widely but still have it somewhere as a starting point