OpenAI 更新组织角色

2026-11-18 00:02 更新

更新组织角色

post /organization/roles/{role_id}

更新现有组织角色。

路径参数

  • role_id: string

要更新的角色 ID。

请求体参数

内容类型:application/json

  • description: optional string or null

角色的新描述。

  • permissions: optional array of string or null

更新后的角色权限集合。

  • role_name: optional string or null

角色的新名称。

返回值

  • Role object { id, description, name, 4 more }

可通过公共 Roles API 分配的角色详情。

  • id: string

角色标识符。

  • description: string or null

可选的角色描述。

  • name: string

角色的唯一名称。

  • object: "role"

固定为 role。

  • "role"

  • permissions: array of string

角色授予的权限。

  • predefined_role: boolean

角色是否由 OpenAI 预定义和管理。

  • resource_type: string

角色绑定的资源类型,例如 api.organization 或 api.project。

示例

## 从环境变量读取管理员密钥;将角色 ID、权限与示例名称替换为实际值
curl "https://api.openai.com/v1/organization/roles/$ROLE_ID" \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
    -d '{}'

200 — 示例

{
  "id": "id",
  "description": "示例角色描述",
  "name": "示例角色名称",
  "object": "role",
  "permissions": [
    "string"
  ],
  "predefined_role": true,
  "resource_type": "resource_type"
}

示例

## 从环境变量读取管理员密钥;将角色 ID、权限与示例名称替换为实际值
curl -X POST "https://api.openai.com/v1/organization/roles/role_01J1F8ROLE01" \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "role_name": "API 群组管理员",
      "permissions": [
          "api.groups.read",
          "api.groups.write"
      ],
      "description": "允许管理组织群组"
  }'

响应示例

{
    "object": "role",
    "id": "role_01J1F8ROLE01",
    "name": "API 群组管理员",
    "description": "允许管理组织群组",
    "permissions": [
        "api.groups.read",
        "api.groups.write"
    ],
    "resource_type": "api.organization",
    "predefined_role": false
}
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号