跳过内容

API密钥

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

导航到 设置>组织>API密钥 在控制台的__CAPGO_KEEP_0__.app/settings/organization/__CAPGO_KEEP_1__-keys console.capgo.app/settings/organization/api-keys.

RBAC Keys

  • —已分配角色(推荐)的密钥。这些密钥使用新的基于角色的权限系统。 Legacy Keys
  • —使用简单模式(,)而无角色分配的旧密钥。 __CAPGO_KEEP_0__密钥列表页面,显示RBAC和Legacy部分read, upload, write, all如何创建一个新的__CAPGO_KEEP_0__密钥?
标题为“如何创建一个新的API密钥?”的部分
  1. —已分配角色(推荐)的密钥。这些密钥使用新的基于角色的权限系统。 ”+” 按钮位于 RBAC keys 表格的顶部。

  2. 填写 密钥信息:

    • 名称 (必填) — 一个描述密钥的标签(例如“CI/CD 部署”,“监控只读”)。
    • 创建安全密钥 (可选) — 当选中时,密钥将在服务器端进行哈希处理。密钥将只显示一次,之后将无法再次获取。 只显示一次 设置过期日期
    • (可选) — 选择一个密钥将失效的日期。一些组织强制实施了过期日期策略。 __CAPGO_KEEP_0__
API key creation form with name, secure key option, and expiration
  1. 选择一个 组织角色 — 这定义了密钥的整个组织中的基线权限。根据您的角色级别,以下角色可用:

    • — 无组织级访问权限;密钥仅对单独分配的应用程序有访问权限。
    • 成员 — 对组织的基本读取访问权限。
    • 管理员 — 对整个组织的完全管理访问权限(继承所有应用程序的访问权限)。
  2. 如果选择的组织角色不是管理员,则可以添加 应用程序级访问:

    • 点击 添加应用 打开应用选择器。
    • 选择一个或多个应用,然后为每个应用分配角色:
      • 应用读者 — 只读访问应用。
      • 应用上传者 — 可上传新包。
      • 应用开发者 — 可管理应用配置和部署。
      • 应用管理员 — 对应用有完全访问权限。
基于角色的访问控制(RBAC)角色选择,包括组织级和应用级角色
  1. 点击 .

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

一次性API密钥密钥模态窗口

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

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

点击 扳手图标 列表中的任何 RBAC 密钥上方的(管理)按钮。这将打开密钥详细页面,您可以在其中:

  • 更改密钥 name.
  • 更新 组织角色.
  • 添加、删除或更改 每个应用程序角色.

点击 完成后。

API 键编辑页面的当前角色设置

如何重新生成一个 API 键?

标题:如何重新生成一个 API 键?

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

确认弹出对话框后:

  • 为了 安全(散列)密钥: 生成并在模态中显示一次新密文密钥。立即复制它。
  • 为了 明文密钥: 密钥值在服务器端重新生成。

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

确认API密钥重生

如何删除API密钥?

如何删除一个 API 键?

点击 列表中的任何键的 删除

确认删除后,键会立即失效,任何使用它的请求都会失败。

删除 API 键确认

过期密钥

过期密钥

如果您在 过期密钥 部分(没有角色分配的密钥),这些使用的是基于模式的旧版权限系统(read, upload, write, all它们仍然有效,但不受 RBAC 的细粒度权限控制

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

如果您需要直接管理遗留密钥,可以在 console.capgo.app/dashboard/apikeys中找到它们。这页面已弃用并将在未来更新中删除。