OpenAI 为群组分配组织角色

为群组分配组织角色

post /organization/groups/{group_id}/roles

在组织内为群组分配一个组织角色。

路径参数

• group_id: string

应接收此组织角色的群组 ID。

请求体参数

内容类型：application/json

• role_id: string

要分配的角色标识符。

返回值

• group: object { id, created_at, name, 2 more }

角色分配响应中返回的群组摘要信息。

• id: string

群组标识符。

• created_at: integer

群组创建时的 Unix 时间戳，单位为秒。

format: unixtime

• name: string

群组显示名称。

• object: "group"

固定为 group。

• "group"

• scim_managed: boolean

群组是否通过 SCIM 管理。

• object: "group.role"

固定为 group.role。

• "group.role"

• role: Role

可通过公共 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/groups/$GROUP_ID/roles \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
    -d '{
          "role_id": "role_id"
        }'

200 — 示例

以下 JSON 展示返回字段；字段名、对象类型、权限字符串和标识符按原文保留。

{
  "group": {
    "id": "id",
    "created_at": 0,
    "name": "示例名称",
    "object": "group",
    "scim_managed": true
  },
  "object": "group.role",
  "role": {
    "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/groups/group_01J1F8ABCDXYZ/roles \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "role_id": "role_01J1F8ROLE01"
  }'

响应示例

以下为对应请求的响应示例，名称和描述已中文化。

{
    "object": "group.role",
    "group": {
        "object": "group",
        "id": "group_01J1F8ABCDXYZ",
        "name": "支持团队",
        "created_at": 1711471533,
        "scim_managed": false
    },
    "role": {
        "object": "role",
        "id": "role_01J1F8ROLE01",
        "name": "API群组管理员",
        "description": "允许管理组织群组",
        "permissions": [
            "api.groups.read",
            "api.groups.write"
        ],
        "resource_type": "api.organization",
        "predefined_role": false
    }
}