OpenAI 列出项目角色
2026-11-17 18:24 更新
列出项目角色
get /projects/{project_id}/roles
列出为项目配置的角色。
路径参数
project_id: string
要查看的项目 ID。
查询参数
after: optional string
分页游标。提供上次响应的 next 字段值,以继续列出角色。
limit: optional integer (default: 1000)
返回的角色数量上限,默认为1000。
minimum: 0, maximum: 1000
order: optional "asc" or "desc" (default: "asc")
返回的角色的排序顺序。
"asc"
"desc"
返回值
data: array of Role
当前页返回的角色。
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。
has_more: boolean
分页时是否还有更多角色可用。
next: string or null
用于获取下一页结果的游标;没有更多角色时为 null。
object: "list"
固定为 list。
"list"
示例
## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl "https://api.openai.com/v1/projects/$PROJECT_ID/roles" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY"
200 — 示例
{
"data": [
{
"id": "id",
"description": "示例描述",
"name": "示例名称",
"object": "role",
"permissions": [
"string"
],
"predefined_role": true,
"resource_type": "resource_type"
}
],
"has_more": true,
"next": "next",
"object": "list"
}
示例
## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl "https://api.openai.com/v1/projects/proj_abc123/roles?limit=20" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json"
响应示例
{
"object": "list",
"data": [
{
"object": "role",
"id": "role_01J1F8PROJ",
"name": "项目 API 密钥管理员",
"description": "允许管理项目的 API 密钥",
"permissions": [
"api.organization.projects.api_keys.read",
"api.organization.projects.api_keys.write"
],
"resource_type": "api.project",
"predefined_role": false
}
],
"has_more": false,
"next": null
}以上内容是否对您有帮助:

TRAE-AI编程


更多建议: