更新指定 Credential 的属性。auth 中的 type 和 secret_name 不可修改。
前提
已完成 Endpoint 与鉴权配置,详见API 总览与认证。
接口
POST /credentials/{credential_id}
路径参数
| 参数 | 必填 | 类型 | 说明 |
|---|---|---|---|
credential_id | 是 | string | Credential ID,格式 cred_xxx |
请求体
| 字段 | 必填 | 类型 | 说明 |
|---|---|---|---|
auth | 否 | object | 认证信息,多态结构,通过 type 区分。更新时 type 与 secret_name 不可修改。 |
display_name | 否 | string | Credential 可读名称,最大 255 字符 |
metadata | 否 | object | 业务自定义键值对元数据 |
请求示例
响应
响应字段
| 字段 | 类型 | 说明 |
|---|---|---|
id | string | Credential ID,格式 cred_xxx |
type | string | 固定为 credential |
vault_id | string | 所属 Vault ID |
display_name | string | Credential 可读名称 |
auth | object | 认证信息,敏感值已脱敏 |
metadata | object | 业务自定义键值对 |
archived_at | string | null | 归档时间,未归档时为 null |
created_at | string | 创建时间,ISO 8601 |
updated_at | string | 最近更新时间,ISO 8601 |
request_id | string | 请求唯一标识 |
错误码
| 状态码 | 错误码 | 说明 |
|---|---|---|
| 400 | InvalidParameter | Required parameter missing or invalid. |
| 401 | InvalidApiKey | Invalid API-key provided. |