API 键

API keys are managed at the organization level with role-based access control (RBAC). Each key can be assigned an organization-wide role and optional per-app roles, giving you fine-grained control over what each key can access.

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

标题：__CAPGO_KEEP_0__ keys管理 Settings > Organization > API Keys 前往 console.capgo.app/settings/organization/api-keys.

设置 > 组织 > __CAPGO_KEEP_0__ Keys

• at 在
• console.__CAPGO_KEEP_0__.app/settings/organization/__CAPGO_KEEP_1__-keys 控制台 > 应用程序 > 设置 > 组织 > __CAPGO_KEEP_1__-keysread, upload, write, all没有角色分配。

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

1. 点击 ”+” 表格顶部的按钮。

2. 填写 密钥信息:

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

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

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

4. 如果选择的组织角色不是管理员，则可以添加 应用级访问:

   • 点击 ”+ Add App” 打开应用选择器。
   • 选择一个或多个应用，然后为每个应用 assignments 角色：
     • 应用阅读者 — 只读访问应用。
     • 应用上传者 — 可以上传新包裹。
     • App 开发者 — 可以管理应用程序配置和部署。
     • App 管理员 — 对应用程序有完全访问权。

5. 点击 “Create”.

6. 如果您勾选了“创建安全密钥”，将会显示一个包含明文密钥的模态窗口。 立即复制它 — 关闭模态窗口后无法再次获取。

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

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

• 修改密钥 名称.
• 更新 组织角色.
• 添加、删除或修改 应用程序角色.

点击 “保存更改” 完成后。

如何重新生成API密钥？

要重新生成API密钥的秘密值，请点击 刷新图标 列表中的任意密钥上的（重新生成）

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

• 对于 安全（散列）密钥: 将生成并在弹出窗口中显示一次新的纯文本密钥。立即复制它。
• 对于 普通密钥: 该密钥值将在服务器端重新生成。

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

如何删除一个 API 密钥?

点击 垃圾桶图标 (删除)列表中的任何密钥。确认删除后在弹窗中确认。

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

遗留密钥

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

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

如果您需要直接管理遗留密钥，请仍然可以访问它们在 console.capgo.app/dashboard/apikeys编辑页面