跳转到主要内容
Pro 方案 包含密码认证。Custom 方案 包含所有认证方式。
启用认证后，用户需先登录才能访问你的文档。

​
认证模式

根据你的访问控制需求，在完整认证和部分认证模式之间进行选择。 完整认证：所有页面均受保护。用户必须先登录才能访问任何内容。 部分认证：部分页面可公开查看，其他页面需要认证。用户可以自由浏览公开内容，访问受保护页面时再进行认证。 在配置下方任一握手机制时，你需要在控制台设置中选择 完整认证 或 部分认证。

​
配置认证

选择要配置的握手方式。
  • 密码
  • Mintlify 控制台
  • OAuth 2.0
  • JWT（JSON Web Token）
密码认证仅提供访问控制，且不支持内容个性化。

​
前提条件

  • 你的安全策略允许在用户之间共享密码。

​
实施

1

创建密码。

  1. 在你的控制台，前往 Authentication。
  2. 选择 Full Authentication 或 Partial Authentication。
  3. 选择 Password。
  4. 输入一个强密码。
  5. 选择 保存更改。
2

分发访问。

将密码和文档站点的 URL 安全地分享给获授权的用户。

​
示例

你的文档托管在 docs.foo.com，你需要基本的访问控制，但不跟踪单个用户。你想阻止公众访问，同时保持设置简单。在控制台中创建一个强密码，并将凭证分享给获授权的用户。就这样！

​
公开页面

在使用部分认证时，所有页面默认受保护。你可以在页面或分组级别通过 public 属性将特定页面设置为无需认证即可访问。

​
单个页面

要将页面设为公开，请在该页面的 frontmatter 中添加 public: true。
Public page example
---
title: "公开页面"
public: true
---

​
页面分组

要将某个分组中的所有页面设为公开，请在 docs.json 的 navigation 对象中，该分组名称下添加 "public": true。
Public group example
{
  "navigation": {
    "groups": [
      {
        "group": "公开组",
        "public": true,
        "icon": "play",
        "pages": [
          "quickstart",
          "installation",
          "settings"
        ]
      },
      {
        "group": "私有组",
        "icon": "pause",
        "pages": [
          "private-information",
          "secret-settings"
        ]
      }
    ]
  }
}

​
使用 groups 控制访问

当你使用 OAuth 或 JWT（JSON Web Token）进行认证时，可以将特定页面仅限于某些用户组访问。若希望不同用户根据其角色或属性查看不同内容，这将非常有用。 groups 通过在认证过程中传递的用户数据进行管理。
Example user info
{
  "groups": ["admin", "beta-users"],
  "content": {
    "firstName": "Jane",
    "lastName": "Doe"
  }
}
使用 frontmatter 中的 groups 属性来指定哪些 groups 可以访问特定页面。
Example page restricted to the admin group
---
title: "管理员控制台"
groups: ["admin"]
---
用户必须至少属于所列的一个 groups 才能访问该页面。如果用户在不具备所需分组的情况下尝试访问页面，将会收到 404 错误。

​
与认证模式的交互

groups 的行为会因认证模式不同而有所差异。 完整认证（配合 groups）：
  • 所有页面都需要认证。
  • 没有 groups 属性的页面对所有已认证用户可访问。
  • 带有 groups 属性的页面仅对属于相应 groups 的已认证用户可访问。
部分认证（配合 groups）：
  • 页面默认需要认证，除非你将其设为公开。
  • 设置了 public: true 且没有 groups 的页面对所有人可访问。
  • 带有 groups 的页面（无论是否设置 public: true）仅对属于相应 groups 的已认证用户可访问。
Anyone can view this page
---
title: "公开指南"
public: true
---
Only authenticated users can view this page
---
title: "API 参考"
---

```mdx 只有 pro 或 enterprise 组中的已认证用户可以查看此页面
---
title: "高级配置"
groups: ["pro", "enterprise"]
---