OpenAI 更新项目 API 密钥

2026-11-17 18:23 更新

更新项目 API 密钥

post /organization/projects/{project_id}/api_keys/{api_key_id}

更新项目中现有 API 密钥的权限范围和/或过期时间,也包括 服务账户拥有的密钥。此操作需要写入项目 API 密钥的权限。

至少提供 scopes 或 expires_in_seconds 之一。省略的字段保持 不变;这两个字段均不接受 null。两项变更会一并保存。

scopes 使用与控制台相同的权限范围标识符,替换密钥的 权限范围限制。空数组表示允许所有权限,但仍受所有者的 有效访问权限约束,并不表示没有访问权限。只读访问使用 ["api.all.read"], 受限访问可使用 ["api.files.read"] 等具体权限范围。 这不会改变用户或服务账户的角色,也不会授予管理员权限。 权限范围变更采用与控制台编辑相同的认证缓存传播机制。

提供 expires_in_seconds 可设置相对于本次请求的过期时间。 该值必须符合组织和项目的过期策略。 已过期的密钥无法更新。重试会相对于 新请求重新设置过期时间。响应仅包含经过遮蔽的密钥,不包含密钥明文。

路径参数

  • project_id: string

项目 ID。

  • api_key_id: string

API 密钥 ID。

请求体参数

内容类型:application/json

  • expires_in_seconds: optional integer

从本次请求起到 API 密钥过期的秒数。必须符合组织和项目的过期策略。已过期的密钥无法更新。重试会相对于新请求重新设置过期时间。省略时保留当前过期时间。

minimum: 1, maximum: 31536000

  • scopes: optional array of string

替换 API 密钥的权限范围限制。省略时保留当前权限范围。空数组会移除密钥限制(允许所有权限),但仍受所有者的有效权限约束。只读访问使用 ["api.all.read"]。权限范围不会改变所有者的角色,也不会授予管理员权限。

返回值

  • ProjectAPIKey object { id, created_at, last_used_at, 6 more }

表示项目中的单个 API 密钥。

  • id: string

标识符,可在 API 端点中引用。

  • created_at: integer

API 密钥创建时间的 Unix 时间戳,单位为秒。

format: unixtime

  • last_used_at: integer or null

API 密钥上次使用时间的 Unix 时间戳,单位为秒。

format: unixtime

  • name: string

API 密钥名称。

  • object: "organization.project.api_key"

对象类型,固定为 organization.project.api_key。

  • "organization.project.api_key"

  • owner: object { service_account, type, user }

  • service_account: optional object { id, created_at, name, role }

拥有项目 API 密钥的服务账户。

  • id: string

标识符,可在 API 端点中引用。

  • created_at: integer

服务账户创建时间的 Unix 时间戳,单位为秒。

format: unixtime

  • name: string

服务账户名称。

  • role: string

服务账户的项目角色。

  • type: optional "user" or "service_account"

user(用户)或 service_account(服务账户)。

  • "user"

  • "service_account"

  • user: optional object { id, created_at, email, 2 more }

拥有项目 API 密钥的用户。

  • id: string

标识符,可在 API 端点中引用。

  • created_at: integer

用户创建时间的 Unix 时间戳,单位为秒。

format: unixtime

  • email: string

用户的电子邮件地址。

  • name: string

用户名称。

  • role: string

用户的项目角色。

  • owner_project_access: "active" or "inactive"

API 密钥所有者当前是否对项目具有有效访问权限。

  • "active"

  • "inactive"

  • redacted_value: string

经过遮蔽的 API 密钥值。

  • expires_at: optional integer or null

API 密钥过期时间的 Unix 时间戳,单位为秒;不过期时为 null。

format: unixtime

示例

## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl "https://api.openai.com/v1/organization/projects/$PROJECT_ID/api_keys/$API_KEY_ID" \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
    -d '{
          "scopes": [
            "api.all.read"
          ]
        }'

200 — 示例

{
  "id": "id",
  "created_at": 0,
  "last_used_at": 0,
  "name": "示例名称",
  "object": "organization.project.api_key",
  "owner": {
    "service_account": {
      "id": "id",
      "created_at": 0,
      "name": "示例名称",
      "role": "role"
    },
    "type": "user",
    "user": {
      "id": "id",
      "created_at": 0,
      "email": "email",
      "name": "示例名称",
      "role": "role"
    }
  },
  "owner_project_access": "active",
  "redacted_value": "redacted_value",
  "expires_at": 0
}

示例

## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl -X POST "https://api.openai.com/v1/organization/projects/proj_abc/api_keys/key_abc" \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{"scopes": ["api.all.read"], "expires_in_seconds": 86400}'

响应示例

{
    "object": "organization.project.api_key",
    "redacted_value": "sk-abc...def",
    "name": "我的 API 密钥",
    "created_at": 1711471533,
    "expires_at": 1711557933,
    "last_used_at": null,
    "id": "key_abc",
    "owner_project_access": "active",
    "owner": {
        "type": "service_account",
        "service_account": {
            "id": "svc_acct_abc",
            "name": "我的服务账户",
            "role": "member",
            "created_at": 1711471533
        }
    }
}
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号