API Keys

API 键的管理位于组织级别，使用基于角色的访问控制（RBAC）。每个键可以分配一个组织级别的角色和可选的每个应用程序角色，从而实现对每个键的访问权限的细粒度控制。

API 键在哪里被管理?

前往 设置 > 组织 > API keys 在 console.capgo.app/settings/organization/api-keys.

页面显示两个部分：

• RBAC keys —已分配角色（推荐）的密钥。这些密钥使用新的基于角色的权限系统。
• Legacy keys —使用简单模式（，）的旧密钥（read, upload, write, all）

如何创建一个新的API密钥?

1. 点击 ”+” 顶部的RBAC密钥表格中的

2. 填写 密钥信息:

   • 名称 (必填) — 密钥的描述性标签（例如“CI/CD部署”，“监控只读”）。
   • 创建安全密钥 (可选) — 当勾选时，密钥将在服务器端进行哈希处理。密钥将只显示一次，之后将无法恢复。 点击 顶部的
   • 设置过期日期 (可选) — 选择一个日期后，密钥将停止工作。一些组织通过政策强制实施过期日期。

3. 选择一个 组织角色 — 这定义了密钥在整个组织中的基本权限。根据您的角色级别，可能可用角色（取决于您的角色级别）：

   • 无 — 无组织级访问权限；密钥仅对单独分配的应用程序有访问权限。
   • 成员 — 基本的组织读取访问权限。
   • 管理员 — 对整个组织的完全管理访问权限（继承所有应用程序的访问权限）

4. 如果需要通过公共API创建组织，启用 允许创建组织.

   This adds the global org.create 权限。它在钥匙具有管理员组织角色时可用。当此钥匙创建新组织时，Capgo会自动将钥匙分配为超级管理员。

5. 如果选定的组织角色不是管理员，您可以添加 per-app访问:

   • 点击 ”+ Add App” 打开应用程序选择器。
   • 选择一个或多个应用程序，然后为每个应用程序 Assign一个角色：
     • App Reader —仅读取应用程序的访问权限。
     • App 上传工具 — 可以上传新包。
     • App 开发者 — 可以管理应用配置和发布。
     • App 管理员 — 对应用有完全访问权限。

6. 点击 “创建”.

7. 如果您选中了“创建安全密钥”，则会显示一个模态窗口，显示明文密钥。 复制它立即 — 关闭模态窗口后无法恢复。

如何管理（编辑）API密钥？

点击 扳手图标 （管理）列表中的任何RBAC密钥。 这会打开密钥详细页面，您可以：

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

点击 “Save Changes” 完成后。

如何重新生成API密钥?

要重新生成API密钥的机密值，请点击 刷新图标 (重新生成)列表中的任意密钥

将会出现一个确认对话框。确认后：

• 用于 安全（散列）密钥: 将会在模态窗口中显示一次新生成的明文密钥，请立即复制它。
• 用于 明文密钥: 将会在服务器端重新生成密钥值。

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

如何删除一个 API 密钥？

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

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

遗留密钥

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

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

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

继续使用API Keys

如果您正在使用 API Keys 来规划仪表板和API 操作，连接它与 API Overview 查看API Overview中的实施细节 介绍 查看介绍中的实施细节 API Keys 对于API Keys的实现细节 设备 对于设备的实现细节，并 捆绑包 对于捆绑包的实现细节。