API Key 管理概述
API Key 管理用于帮助企业在 VeriAgent 平台中统一管理外部系统访问凭证。通过 API Key 管理,企业可以创建、查询、编辑和删除 API Key,并查看凭证状态、最近使用时间和更新时间。
当外部系统、脚本或自动化流程需要访问 VeriAgent 服务时,通常需要使用 API Key 完成身份识别和访问控制。通过 API Key 管理,企业可以按系统、环境或用途拆分访问凭证,降低凭证混用、泄露或长期未清理带来的安全风险。
注意:API Key 明文仅在创建成功后展示一次,请在创建后立即复制并妥善保存。
API Key 管理能力
VeriAgent 的 API Key 管理能力主要包括以下功能:
| 功能 | 说明 |
|---|---|
| 创建 API Key | 为外部系统或自动化流程创建访问凭证。 |
| 查询 API Key | 按名称、描述或状态筛选 API Key,查看凭证列表。 |
| 编辑 API Key | 修改 API Key 的名称、描述等信息。 |
| 删除 API Key | 删除不再使用的访问凭证,避免无效凭证继续被调用。 |
API Key 使用路径
API Key 通常按以下流程使用:
text
创建 API Key → 保存密钥明文 → 配置到外部系统 → 按需编辑或删除如果 API Key 用于测试环境,建议单独创建测试凭证,避免与生产环境共用。
如果 API Key 不再使用,建议先确认调用方已停用或切换到新凭证,再删除旧凭证。
API Key 列表信息
API Key 管理页面的列表展示以下信息:
| 字段 | 说明 |
|---|---|
| 名称 | API Key 的名称,用于区分不同凭证。 |
| 所属用户 | 创建或归属该 API Key 的用户。 |
| 描述 | API Key 的用途说明。 |
| Key 标识 | API Key 的标识信息,用于识别凭证。 |
| 状态 | 当前 API Key 是否启用。 |
| 最近使用 | API Key 最近一次被调用的时间。 |
| 更新时间 | API Key 最近一次更新的时间。 |
| 操作 | 支持编辑或删除 API Key。 |
为什么需要 API Key 管理
API Key 管理能力可以帮助企业建立以下安全和运维基础:
- 为不同系统、环境或用途创建独立凭证,避免多个调用方共用同一个 API Key。
- 通过状态和最近使用时间识别长期未使用或需要清理的凭证。
- 在外部系统下线、权限调整或人员交接时,及时删除不再使用的 API Key。
- 将外部系统访问凭证集中在同一页面管理,便于后续审计、复核和问题定位。
使用结果
完成 API Key 管理相关操作后,企业可以在 VeriAgent 平台中持续管理外部访问凭证,包括:
- API Key 名称、描述和所属用户
- Key 标识
- 启用状态
- 最近使用时间
- 更新时间
- API Key 的维护和清理
通过这些能力,企业可将外部系统访问 VeriAgent 的凭证从“单次创建后手动保存”升级为“可查询、可维护、可清理、可追溯的访问凭证资产”。