概览

控制谁可以查看你的文档，并自定义其使用体验

Pro 方案包含密码认证。

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

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

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

适用场景示例

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

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

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

• 提供公开的入门指南，同时将高级功能设为私有
• 运营免费增值产品，为付费用户提供额外文档
• 发布开源文档，同时包含私有的企业版章节

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

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

握手方式

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

方法	适用范围	设置复杂度	最适合
JWT	所有方案	中等	自定义登录流程，最大化安全管控
OAuth 2.0	所有方案	高	第三方认证提供商，企业级安全
Mintlify Dashboard	仅认证	低	已使用 Mintlify 仪表盘的团队
Password	仅认证	低	无需个性化的简单共享访问
Shared Session	仅个性化	低	已有基于会话的认证的应用

何时使用各方式

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

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

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

Password：当你不需要跟踪个体用户或个性化内容、只需简单访问控制时使用。适用于外包方、内测用户或临时访问场景。

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

内容自定义

这三种方式均支持内容个性化功能，包括动态 MDX 内容、API 密钥预填充和页面可见性控制。有关详细的实现指南，请参见个性化设置。