概览

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

Pro 方案包含密码验证。

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

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

• 完全身份验证：为所有内容提供完备的隐私保护，并支持全面的内容定制。
• 部分身份验证：逐页进行访问控制，并支持全面的内容定制。
• 个性化：仅进行内容定制，不提供任何安全保证。所有内容仍对公众可见。

用例示例

在以下情况下选择完整身份验证：

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

在以下情况下选择部分身份验证：

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

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

• 创建公开的 API 文档，展示与用户相关的个性化示例
• 搭建营销站点，根据用户画像定制内容
• 提供公开教程，根据用户偏好或技能水平进行自适应

握手机制

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

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

何时使用各个方法

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

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

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

Password：在不需要跟踪个体用户或进行内容个性化时，用于简单的访问控制。适用于外包人员、内测用户或临时访问场景。

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

内容自定义

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