diff --git a/authentication-personalization/authentication-setup.mdx b/authentication-personalization/authentication-setup.mdx
index 3de945a6d..2af330ffa 100644
--- a/authentication-personalization/authentication-setup.mdx
+++ b/authentication-personalization/authentication-setup.mdx
@@ -2,6 +2,7 @@
title: "Authentication setup"
description: "Guarantee privacy of your docs by authenticating users"
icon: "file-lock"
+keywords: ['auth']
---
Authentication requires users to log in before accessing your documentation. This guide covers setup for each available handshake method.
diff --git a/authentication-personalization/overview.mdx b/authentication-personalization/overview.mdx
index ce9354450..7f807d741 100644
--- a/authentication-personalization/overview.mdx
+++ b/authentication-personalization/overview.mdx
@@ -2,16 +2,19 @@
title: "Overview"
description: "Control who sees your documentation and customize their experience"
icon: "badge-info"
+keywords: ["auth"]
---
+
- Authentication methods are available on the [Growth and Enterprise plans](https://mintlify.com/pricing?ref=authentication).
+ Authentication methods are available on the [Growth and Enterprise
+ plans](https://mintlify.com/pricing?ref=authentication).
There are three approaches to manage access and customize your documentation based on user information.
-* **Authentication**: Complete privacy protection for all content with full content customization.
-* **Partial authentication**: Page-by-page access control with full content customization.
-* **Personalization**: Content customization with **no security guarantees**. All content remains publicly accessible.
+- **Authentication**: Complete privacy protection for all content with full content customization.
+- **Partial authentication**: Page-by-page access control with full content customization.
+- **Personalization**: Content customization with **no security guarantees**. All content remains publicly accessible.
**Choose authentication** if you need complete security and privacy for all your documentation, including pages, images, search results, and AI assistant features.
@@ -26,50 +29,55 @@ Authentication and personalization offer multiple handshake methods for controll
### Available for all methods
**JSON Web Token (JWT)**: Custom system where you manage user tokens with full control over the login flow.
-* Pros of JWT:
- * Reduced risk of API endpoint abuse.
- * No CORS configuration.
- * No restrictions on API URLs.
-* Cons of JWT:
- * Must be compatible with your existing login flow.
- * Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
- * When you refresh user data, users must log into your docs again. If your users' data changes frequently, they must log in frequently or risk having stale data in your docs.
+
+- Pros of JWT:
+ - Reduced risk of API endpoint abuse.
+ - No CORS configuration.
+ - No restrictions on API URLs.
+- Cons of JWT:
+ - Must be compatible with your existing login flow.
+ - Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
+ - When you refresh user data, users must log into your docs again. If your users' data changes frequently, they must log in frequently or risk having stale data in your docs.
**OAuth 2.0**: Third-party login integration like Google, GitHub, or other OAuth providers.
-* Pros of OAuth 2.0:
- * Heightened security standard.
- * No restrictions on API URLs.
-* Cons of OAuth 2.0:
- * Requires significant work if setting up an OAuth server for the first time.
- * Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
-### Available for authentication and partial authentication
+- Pros of OAuth 2.0:
+ - Heightened security standard.
+ - No restrictions on API URLs.
+- Cons of OAuth 2.0:
+ - Requires significant work if setting up an OAuth server for the first time.
+ - Dashboard sessions and docs authentication are decoupled, so your team will log into your dashboard and your docs separately.
+
+### Available for authentication and partial authentication
**Mintlify dashboard**: Allow all of your dashboard users to access your docs.
-* Pros of Mintlify dashboard:
- * No configuration required.
- * Enables private preview deployments, restricting access to authenticated users only.
-* Cons of Mintlify dashboard:
- * Requires all users of your docs to have an account in your Mintlify dashboard.
+
+- Pros of Mintlify dashboard:
+ - No configuration required.
+ - Enables private preview deployments, restricting access to authenticated users only.
+- Cons of Mintlify dashboard:
+ - Requires all users of your docs to have an account in your Mintlify dashboard.
**Password**: Shared access with a single global password. Used for access control only. Does not allow for personalization.
-* Pros of password:
- * Simple setup with no configuration required to add new users, just share the password.
-* Cons of password:
- * Lose personalization features since there is no way to differentiate users with the same password.
- * Must change the password to revoke access.
+
+- Pros of password:
+ - Simple setup with no configuration required to add new users, just share the password.
+- Cons of password:
+ - Lose personalization features since there is no way to differentiate users with the same password.
+ - Must change the password to revoke access.
### Available for personalization
**Shared session**: Use the same session token as your dashboard to personalize content.
-* Pros of shared session:
- * Users that are logged into your dashboard are automatically logged into your docs.
- * User sessions are persistent so you can refresh data without requiring a new login.
- * Minimal setup.
-* Cons of shared session:
- * Your docs will make a request to your backend.
- * You must have a dashboard that uses session authentication.
- * CORS configuration is generally required.
+
+- Pros of shared session:
+ - Users that are logged into your dashboard are automatically logged into your docs.
+ - User sessions are persistent so you can refresh data without requiring a new login.
+ - Minimal setup.
+- Cons of shared session:
+ - Your docs will make a request to your backend.
+ - You must have a dashboard that uses session authentication.
+ - CORS configuration is generally required.
## Content customization
@@ -108,10 +116,10 @@ Authentication is an enterprise feature. {
```
- The information in `user` is only available for logged in users. For
- logged out users, the value of `user` will be `{}`. To prevent the page from
- crashing for logged out users, always use optional chaining on your `user`
- fields. For example, `{user.org?.plan}`.
+ The information in `user` is only available for logged in users. For logged
+ out users, the value of `user` will be `{}`. To prevent the page from crashing
+ for logged out users, always use optional chaining on your `user` fields. For
+ example, `{user.org?.plan}`.
### API key prefilling
diff --git a/authentication-personalization/partial-authentication-setup.mdx b/authentication-personalization/partial-authentication-setup.mdx
index ca7ffb705..f3b0e384a 100644
--- a/authentication-personalization/partial-authentication-setup.mdx
+++ b/authentication-personalization/partial-authentication-setup.mdx
@@ -2,6 +2,7 @@
title: "Partial authentication setup"
description: "Control access to specific pages"
icon: "file-lock-2"
+keywords: ["auth"]
---
Partial authentication lets you protect private documentation while keeping other pages publicly viewable. Users can browse public content freely and authenticate only when accessing protected pages.