Skip to content

Rename Mintlify auth to private #6396

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.

Sign up for GitHub

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
ethanpalm merged 1 commit into from
Jul 6, 2026
Merged

Rename Mintlify auth to private #6396

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 11 additions & 13 deletions deploy/authentication-setup.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Authentication setup"
description: "Configure user authentication for your site with OAuth, JWT, password, or Mintlify Auth to control access to pages and API references."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password']
description: "Configure user authentication for your site to control access to pages and API references. Make pages private to your Mintlify organization, or use password, OAuth, or JWT authentication."
keywords: ['authentication', 'auth', 'OAuth', 'JWT', 'password', 'private']
---

<Info>
Authentication with Mintlify Auth is available on all plans.
Private authentication for your Mintlify organization is available on all plans.

Password authentication is available on the [Pro plan and above](https://mintlify.com/pricing?ref=authentication).
Password authentication requires a [Pro or Enterprise plan](https://mintlify.com/pricing?ref=authentication).

OAuth and JWT authentication require an [Enterprise plan](https://mintlify.com/pricing?ref=authentication).
</Info>
Expand All @@ -20,8 +20,6 @@ Authentication is only available for sites hosted on a custom domain or Mintlify

## Configure authentication

Select the handshake method that you want to configure.

<Tabs>
<Tab title="Password">
<Info>
Expand Down Expand Up @@ -55,15 +53,15 @@ You host your documentation at `docs.foo.com` and you need basic access control

**Create a strong password** in your dashboard. **Share credentials** with authorized users.
</Tab>
<Tab title="Mintlify Auth">
### Mintlify Auth prerequisites
<Tab title="Private authentication">
### Private authentication prerequisites

* Everyone who needs to access your documentation must be a member of your Mintlify organization.
* Everyone who needs to access your site must be a member of your Mintlify organization.

### Mintlify Auth setup
### Private authentication setup

<Steps>
<Step title="Enable Mintlify authentication.">
<Step title="Enable private authentication.">
1. In your dashboard, go to [Authentication](https://app.mintlify.com/products/authentication).
2. In the **Authentication method** section, set site visibility to **Private**.
3. Click **Authenticated**.
Expand All @@ -78,11 +76,11 @@ You host your documentation at `docs.foo.com` and you need basic access control
</Step>
</Steps>

### Mintlify Auth example
### Private example

You host your documentation at `docs.foo.com` and your entire team has access to your dashboard. You want to restrict access to team members only.

**Enable Mintlify authentication** in your dashboard settings.
**Enable private authentication** in your dashboard settings.

**Verify team access** by checking that all team members are active in your organization.
</Tab>
Expand Down
Loading