OpenAI 获取群组的组织角色

获取群组的组织角色

get /organization/groups/{group_id}/roles/{role_id}

获取已分配给群组的一个组织角色。

路径参数

• group_id: string

要查看的群组 ID。

• role_id: string

要获取的、已分配给此群组的组织角色 ID。

返回值

• 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

示例

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

200 — 示例

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

{
  "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
}

示例

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

响应示例

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

{
    "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": null,
    "metadata": {},
    "assignment_sources": null
}