OpenAI 列出群组的组织角色分配

列出群组的组织角色分配

get /organization/groups/{group_id}/roles

列出组织内已分配给群组的组织角色。

路径参数

• group_id: string

要列出其组织角色分配的群组 ID。

查询参数

• after: optional string

分页游标。传入上一响应的 next 字段值，以继续列出组织角色。

• limit: optional integer

返回的组织角色分配数量上限。

minimum: 0, maximum: 1000

• order: optional "asc" or "desc"

返回的组织角色的排序方式。

• "asc"

• "desc"

返回值

• data: array of object { id, assignment_sources, created_at, 9 more }

当前页返回的角色分配。

• id: string

角色标识符。

• assignment_sources: array of object { principal_id, principal_type } or null

此角色分配继承自哪些主体（如果提供）。

• principal_id: string

• principal_type: string

• created_at: integer or null

角色的创建时间。

format: unixtime

• created_by: string or null

创建此角色的执行者标识符。

• created_by_user_obj: map[unknown] or null

创建此角色的执行者的用户详细信息（如果提供）。

• description: string or null

角色描述。

• metadata: map[unknown] or null

存储在角色上的任意元数据。

• name: string

角色名称。

• permissions: array of string

与此角色关联的权限。

• predefined_role: boolean

角色是否由 OpenAI 预定义。

• resource_type: string

角色适用的资源类型。

• updated_at: integer or null

角色的最近更新时间。

format: unixtime

• has_more: boolean

分页时是否还有其他角色分配可获取。

• next: string or null

获取下一页结果的游标；没有更多分配时为 null。

• object: "list"

固定为 list。

• "list"

示例

## 从环境变量读取管理员密钥；群组、角色和用户ID应替换为实际值
curl https://api.openai.com/v1/organization/groups/$GROUP_ID/roles \
    -H "Authorization: Bearer $OPENAI_ADMIN_KEY"

200 — 示例

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

{
  "data": [
    {
      "id": "id",
      "assignment_sources": [
        {
          "principal_id": "principal_id",
          "principal_type": "principal_type"
        }
      ],
      "created_at": 0,
      "created_by": "created_by",
      "created_by_user_obj": {
        "foo": "bar"
      },
      "description": "示例描述",
      "metadata": {
        "foo": "bar"
      },
      "name": "示例名称",
      "permissions": [
        "string"
      ],
      "predefined_role": true,
      "resource_type": "resource_type",
      "updated_at": 0
    }
  ],
  "has_more": true,
  "next": "next",
  "object": "list"
}

示例

## 从环境变量读取管理员密钥；群组、角色和用户ID应替换为实际值
curl https://api.openai.com/v1/organization/groups/group_01J1F8ABCDXYZ/roles \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应示例

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

{
    "object": "list",
    "data": [
        {
            "id": "role_01J1F8ROLE01",
            "name": "API群组管理员",
            "permissions": [
                "api.groups.read",
                "api.groups.write"
            ],
            "resource_type": "api.organization",
            "predefined_role": false,
            "description": "允许管理组织群组",
            "created_at": 1711471533,
            "updated_at": 1711472599,
            "created_by": "user_abc123",
            "created_by_user_obj": {
                "id": "user_abc123",
                "name": "艾达·洛芙莱斯",
                "email": "ada@example.com"
            },
            "metadata": {},
            "assignment_sources": [
                {
                    "principal_id": "group_01J1F8ABCDXYZ",
                    "principal_type": "group"
                }
            ]
        }
    ],
    "has_more": false,
    "next": null
}