跳过内容

API密钥

API密钥由组织级别的角色访问控制(RBAC)管理。每个密钥可以分配一个组织级别的角色和可选的每个应用程序角色,从而实现对每个密钥的访问权限的细粒度控制。

哪里管理API密钥?

标题:哪里管理API密钥?

导航到 设置 > 组织 > API 密钥console.capgo.app/settings/organization/api-keys.

页面显示两个部分:

  • RBAC 密钥 —已分配角色(推荐)的密钥。这些密钥使用基于角色的新权限系统。
  • 遗留密钥 —使用简单模式(,)的旧系统(无角色 assignments)read, upload, write, all__CAPGO_KEEP_0__ 密钥列表页面显示 RBAC 和 Legacy 部分
如何创建一个新的API密钥?
  1. 点击 ”+” 顶部的RBAC密钥表格中的

  2. 按钮。 填写:

    • 密钥信息 名称
    • (必填) — 密钥的描述性标签(例如“CI/CD部署”,“监控只读”)。 创建安全密钥 (可选) — 当勾选时,密钥将在服务器端进行哈希处理。密钥的明文将只在创建后显示一次。您将无法在以后恢复它。 设置过期日期
    • (可选) (optional) — 选择一个日期后,该密钥将失效。一些组织通过政策强制实施密钥过期。
API 名称、安全密钥选项和过期时间的密钥创建表单
  1. Select an 组织角色 — 这定义了密钥在整个组织中的基本权限。根据您的角色级别,以下角色可用:

    • None — 无组织级访问权限;密钥仅对单独赋予的应用程序有访问权限。
    • Member — 基本读取访问组织。
    • Admin — 对整个组织具有完全的管理访问权限(继承所有应用程序的访问权限)。
  2. 如果密钥需要通过公共 API 创建组织,请启用 允许创建组织.

    这会添加全局 org.create 权限。它在钥匙具有管理员组织角色时可用。当此钥匙创建新组织时,Capgo会自动将钥匙作为超级管理员分配到该新组织。

  3. 如果所选的组织角色不是管理员,则可以添加 按应用程序访问:

    • 点击 ”+ Add App” 打开应用程序选择器。
    • 选择一个或多个应用程序,然后为每个应用程序 assignments 角色:
      • 应用程序读者 —仅读取应用程序的访问权限。
      • 应用程序上传者 — 可以上传新包。
      • App 开发者 — 可以管理应用配置和发布。
      • App 管理员 — 对应用有完全访问权限。
基于角色的访问控制(RBAC)角色选择,支持组织级别和应用级别角色
  1. 点击 “创建”.

  2. 如果您选中了“创建安全密钥”,将显示一个包含明文密钥的模态窗口。 立即复制它 — 模态窗口关闭后无法恢复密钥。

一次性 API 密钥密钥模态窗口,带复制按钮

How to manage (edit) an API key?

如何管理(编辑)一个 API 密钥?

点击 扳手图标 (管理) 列表中的任何 RBAC 密钥。 这会打开密钥详细页面,您可以在此处:

  • 修改密钥 名称.
  • 更新 组织角色.
  • 启用或禁用 允许创建组织 当密钥具有管理员组织角色时。
  • 添加、删除或更改 每个应用程序的角色.

点击 “Save Changes” 完成后。

API密钥编辑页面

如何重新生成API密钥?

标题:如何重新生成API密钥?

重新生成API密钥的秘密值,点击 刷新图标 (重新生成)列表中的任意一个密钥

将出现确认对话框。确认后:

  • For secure (hashed) keys:生成并显示一次新文本密钥,通过弹窗。
  • For plain keys:服务器端重新生成密钥值。

任何使用旧密钥值的集成将立即停止工作。

API密钥重生确认

如何删除API密钥?

如何删除API密钥?

点击 垃圾桶图标 在列表中任意按键(Delete)确认删除。

立即撤销该密钥 — 使用它的任何请求都会失败。

API 密钥删除确认对话框

如果您看到在 遗留密钥 部分(没有角色分配的密钥),这些使用基于模式的旧版权限系统(read, upload, write, all)。它们仍然有效,但不受 RBAC 精细权限的益处。

遗留密钥可以从列表中重新生成和删除,但不能编辑添加 RBAC 角色。我们建议创建新 RBAC 密钥并删除遗留密钥时可能。

如果您需要直接管理遗留密钥,可以访问它们在 console.capgo.app/dashboard/apikeys. 本页面已过时,将在未来更新中删除。

继续使用 API Keys

标题:继续使用 API Keys

如果您正在使用 API Keys 来规划仪表板和 API 操作,连接它与 API Overview 查看 API Overview 中的实施细节 介绍 查看介绍中的实施细节 API Keys 查看 API Keys 中的实施细节 设备 查看设备的详细信息 查看包的详细信息