跳过内容

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.

__CAPGO_KEEP_0__关键字在哪里管理? 标题为“API关键字在哪里管理?”的部分 导航到 console.capgo.app/settings/organization/api-keys.

在console.__CAPGO_KEEP_0__.app/settings/organization/__CAPGO_KEEP_1__-keys中找到此页面显示两个部分:

  • RBAC Keys — 分配角色(推荐)的密钥。这些密钥使用基于角色的新权限系统。
  • Legacy Keys — 使用简单模式系统(,)而无角色分配的旧密钥。read, upload, write, all__CAPGO_KEEP_0__ keys 列表页面显示 RBAC 和 Legacy 部分
如何创建一个新的 API 密钥?

标题为“如何创建一个新的 API 密钥?”的部分

Section titled “How to create a new API key?”
  1. 按钮 ”+” 填写

  2. 密钥信息 如何创建一个新的 __CAPGO_KEEP_0__ 密钥?:

    • 名称 (required) — 关键的描述标签(例如“CI/CD 部署”,“监控只读”)。
    • 创建安全密钥 (optional) — 当选中时,密钥将在服务器端进行哈希处理。您只会在创建密钥后看到明文密钥。您无法在之后恢复它。 设置过期日期 (optional) — 选择一个日期后,该密钥将失效。一些组织强制执行密钥过期的政策。
    • __CAPGO_KEEP_0__ 名称、安全密钥选项和过期日期的密钥创建表单 选择一个
API key creation form with name, secure key option, and expiration
  1. — 这定义了密钥在整个组织中的基本权限。可用角色(取决于您的角色级别): __CAPGO_KEEP_0__ __CAPGO_KEEP_0__

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

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

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

    • 点击 ”+ 添加应用” 打开应用程序选择器。
    • 选择一个或多个应用程序,然后为每个应用程序 Assign 角色:
      • 应用程序读者 — 只读访问应用程序。
      • 应用程序上传者 — 可以上传新包。
      • 应用程序开发者 — 可以管理应用程序配置和部署。
      • 应用程序管理员 — 对应用程序有完全访问权限。
RBAC role selection with org-level and per-app roles
  1. Click “Create”.

  2. If you checked “Create secure key”, a modal will display the plain-text key. Copy it immediately — it cannot be retrieved after closing the modal.

One-time API key secret modal with copy button

Click the wrench icon (Manage) on any RBAC key in the list. This opens the key detail page where you can:

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

“保存更改” 完成后 __CAPGO_KEEP_0__

API 键编辑页面

如何重新生成一个 API 键?

如何重新生成一个 API 键?

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

确认弹窗将出现。确认后:

  • 对于 安全(散列)键: 在弹窗中显示并复制一次新生成的文本键。
  • 对于 文本键: 服务端重新生成了密钥值。

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

API 密钥重新生成确认

如何删除一个 API 密钥?

标题:如何删除一个 API 密钥?

点击 垃圾桶图标 (删除)列表中的任何密钥。确认删除对话框。

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

API 密钥删除确认对话框

如果您看到在"Legacy Keys"(遗留密钥)部分(没有角色赋予的密钥)中显示的密钥,这些使用基于模式的旧式权限系统()。它们仍然有效,但不受RBAC细粒度权限的益处。 Legacy Keys 这些密钥使用基于模式的旧式权限系统()。read, upload, write, all遗留密钥可以重新生成并从列表中删除,但无法编辑以添加RBAC角色。我们建议创建新的RBAC密钥并在可能时删除遗留密钥。

如果您需要直接管理遗留密钥,可以访问

console.__CAPGO_KEEP_0__.app/dashboard/apikeys console.capgo.app/dashboard/apikeys从"__CAPGO_KEEP_0__ Keys"继续

标题:从"API Keys"继续

如果您正在使用"API Keys"

__CAPGO_KEEP_0__ Keys API Keys 为了计划仪表板和API操作,连接它与 API概览 为了在API概览中实现详细信息, 介绍 为了在介绍中实现详细信息, API密钥 为了在API密钥中实现详细信息, 设备 为了在设备中实现详细信息, 捆绑包 为了在捆绑包中实现详细信息,