OpenAI 向用户分配项目角色
向用户分配项目角色
post /projects/{project_id}/users/{user_id}/roles
在项目中向用户分配项目角色。
路径参数
project_id: string
要更新的项目 ID。
user_id: string
要接收项目角色的用户 ID。
请求体参数
内容类型:application/json
role_id: string
要分配的角色标识符。
返回值
object: "user.role"
固定为 user.role。
"user.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。
user: OrganizationUser
表示组织中的单个 user(用户)。
id: string
标识符,可在 API 端点中引用。
added_at: integer
用户添加时间的 Unix 时间戳,单位为秒。
format: unixtime
object: "organization.user"
对象类型,固定为 organization.user。
"organization.user"
api_key_last_used_at: optional integer or null
用户上次使用 API 密钥时间的 Unix 时间戳,单位为秒。
format: unixtime
created: optional integer
用户创建时间的 Unix 时间戳,单位为秒。
format: unixtime
developer_persona: optional string or null
用户的开发者画像元数据。
email: optional string or null
用户的电子邮件地址。
is_default: optional boolean
是否为组织的默认用户。
is_scale_tier_authorized_purchaser: optional boolean or null
用户是否为 Scale Tier 的授权采购者。
is_scim_managed: optional boolean
用户是否通过 SCIM 管理。
is_service_account: optional boolean
用户是否为服务账户。
name: optional string or null
用户名称。
projects: optional object { data, object } or null
与用户关联的项目(如果包含)。
data: array of object { id, name, role }
id: optional string or null
name: optional string or null
role: optional string or null
object: "list"
"list"
role: optional string or null
owner(所有者)或 reader(读取者)。
technical_level: optional string or null
用户的技术水平元数据。
user: optional object { id, object, banned, 5 more }
嵌套的用户详情。
id: string
object: "user"
"user"
banned: optional boolean or null
banned_at: optional integer or null
format: unixtime
email: optional string or null
enabled: optional boolean or null
name: optional string or null
picture: optional string or null
示例
## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl "https://api.openai.com/v1/projects/$PROJECT_ID/users/$USER_ID/roles" \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-d '{
"role_id": "role_id"
}'
200 — 示例
{
"object": "user.role",
"role": {
"id": "id",
"description": "示例描述",
"name": "示例名称",
"object": "role",
"permissions": [
"string"
],
"predefined_role": true,
"resource_type": "resource_type"
},
"user": {
"id": "id",
"added_at": 0,
"object": "organization.user",
"api_key_last_used_at": 0,
"created": 0,
"developer_persona": "developer_persona",
"email": "email",
"is_default": true,
"is_scale_tier_authorized_purchaser": true,
"is_scim_managed": true,
"is_service_account": true,
"name": "示例名称",
"projects": {
"data": [
{
"id": "id",
"name": "示例名称",
"role": "role"
}
],
"object": "list"
},
"role": "role",
"technical_level": "technical_level",
"user": {
"id": "id",
"object": "user",
"banned": true,
"banned_at": 0,
"email": "email",
"enabled": true,
"name": "示例名称",
"picture": "picture"
}
}
}
示例
## 从环境变量读取管理员密钥;先把项目、资源 ID 和请求参数替换为实际值
curl -X POST "https://api.openai.com/v1/projects/proj_abc123/users/user_abc123/roles" \
-H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
-H "Content-Type: application/json" \
-d '{
"role_id": "role_01J1F8PROJ"
}'
响应示例
{
"object": "user.role",
"user": {
"object": "organization.user",
"id": "user_abc123",
"name": "艾达·洛夫莱斯",
"email": "ada@example.com",
"role": "owner",
"added_at": 1711470000
},
"role": {
"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
}
}
TRAE-AI编程


更多建议: