Overview

控制谁能查看你的文档，并自定义他们的使用体验

Pro 方案 包含密码认证。

Enterprise 方案 包含所有认证方式。

根据用户信息和你的安全需求，从以下三种方式中选择，以管理访问并自定义你的文档：

• 完全认证：为所有内容提供完整的隐私保护，并支持全面的内容自定义。
• 部分认证：按页面进行访问控制，并支持全面的内容自定义。
• 个性化：提供内容自定义，但不提供任何安全保证。所有内容仍对公众开放。

用例示例

在以下情况下选择完全认证：

• 构建包含敏感信息的公司内部文档
• 编写需要用户验证的专有 API 文档
• 创建针对特定客户的实施指南

在以下情况下选择部分认证：

• 提供公开的入门指南，同时包含私有的高级功能
• 发布开源文档并附带私有的企业版部分

在以下情况下选择个性化：

• 创建公开的 API 文档，展示针对用户的示例
• 构建可根据用户画像定制内容的营销网站
• 提供可根据用户偏好或技能水平自适应的公开教程

握手方式

选择最符合你现有基础设施与安全要求的方法。

方法	适用范围	设置复杂度	最适合
JWT（JSON Web Token）	所有方案	中等	自定义登录流程，最大化安全控制
OAuth 2.0	所有方案	高	第三方认证提供商、企业级安全
Mintlify 控制台	仅限认证	低	已在使用 Mintlify 控制台的团队
密码	仅限认证	低	无个性化的简单共享访问
共享会话	仅限个性化	低	已有基于会话的认证的应用

何时使用每种方法

JWT（JSON Web Token）：当你已有认证系统并希望完全掌控登录流程时使用。适用于自定义用户管理，或当你需要将文档访问与主应用解耦时。

OAuth 2.0：当你想使用第三方认证提供商（Google、GitHub 等）或需要企业级安全标准时使用。最适合已采用 OAuth 基础设施的组织。

Mintlify 控制台：当你的文档编辑者同时也是文档读者时使用。非常适合已通过 Mintlify 控制台管理内容的内部团队。

Password：用于不需要跟踪个体用户或个性化内容的简单访问控制。适用于外部合作方、内测用户或临时访问场景。

Shared Session：当你希望在应用与文档之间实现无缝登录时使用。适用于用户已在主应用中完成认证，且你希望个性化其文档体验的场景。

内容自定义

这三种方式均支持内容个性化功能，包括动态 MDX 内容、API key 预填、以及页面可见性控制。有关具体实现指南，请参见个性化设置。