如何为 Scalar Docs 项目配置 Access Groups 实现按域名或邮箱限制的私有文档
如何为 Scalar Docs 项目配置 Access Groups 实现按域名或邮箱限制的私有文档【免费下载链接】scalarScalar is an open-source API platform: Modern REST API Client Beautiful API References ✨ 1st-Class OpenAPI/Swagger Support项目地址: https://gitcode.com/GitHub_Trending/sc/scalar当你用 Scalar Docs 发布了一组文档但不希望所有人都能直接打开而是只允许特定公司域名下的邮箱、或指定的几个邮箱地址查看时可以使用 Scalar 的 Access Groups访问组。Access Group 本质上是一个邮箱/域名白名单把一组域名或邮箱加入组里再把 Docs 项目的 Private Docs 功能绑定到这个组只有名单内的用户才能阅读该文档。前提是你已经拥有 Scalar 账号并登录了 Scalar 控制台dashboard.scalar.com。如果还没有账号先到控制台的注册页创建账号再开始下面的操作。Docs 项目本身可以来自控制台创建、Starter Kit或任意包含scalar.config.json的目录见 Docs 入门。创建 Access Group 并添加允许项在控制台最左侧边栏进入Access Groups点击Create Access Group创建第一个访问组。为访问组添加允许访问的条目两种方式可以混用按域名放行输入要放行的域名例如acme.com点击add。这相当于对整个域名的 catch-all 放行。按邮箱放行输入具体的邮箱地址例如customeracme.com点击add只允许这些精确的邮箱。把 Docs 项目设为私有并绑定访问组打开你要限制的 Docs 项目进入Security区域。确认Private Docs已启用。在允许访问的访问组中选择你刚创建的组。选中组之后该项目的文档即为私有只有被启用访问组内的域名/邮箱能查看这个 Docs 项目。验证访问限制与回收权限成功的标志绑定访问组后文档不再公开仅访问组内条目对应的用户可访问。回收权限删除某个访问组后权限变更立即生效对应用户的访问会被撤销。文档中还提到可以按需自定义登录页的品牌展示可选不影响访问控制本身。完整的操作路径参见 Private Docs 指南。边界说明Access Groups 不是团队成员Scalar 文档中特别区分了两个容易混淆的概念见 User ManagementTeam members是在 Scalar 控制台里和你一起构建文档、API、SDK 的协作者按 Owner / Admin / Editor 角色管理Access groups只决定谁有权阅读你的私有文档这些用户不需要占用团队席位也不会看到控制台。因此惯例是同事用 team members 邀请客户或只需要阅读文档的合作伙伴用 access groups。完成以上步骤后你的 Scalar Docs 项目就只对指定域名或邮箱开放想收紧范围时编辑或删除访问组即可撤销立即生效。账号注册流程可参考 Registry Getting Started。【免费下载链接】scalarScalar is an open-source API platform: Modern REST API Client Beautiful API References ✨ 1st-Class OpenAPI/Swagger Support项目地址: https://gitcode.com/GitHub_Trending/sc/scalar创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考