OpenAI API参考文档 | OpenAI开发文档|OpenAI中文官方文档|ChatGPT中文版|ChatGPT教程

用户

管理用户及其在组织中的角色。用户将自动添加到 Default 项目。source

列出用户

获取 https://api.openai.com/v1/organization/users

列出组织中的所有用户。source

查询参数

限制

整数source

可选

默认为 20

要返回的对象数量限制。Limit 的范围可以介于 1 和 100 之间，默认值为 20。source

后

字符串source

可选

用于分页的游标。after是定义您在列表中的位置的对象 ID。例如，如果您发出列表请求并收到 100 个对象，以 obj_foo 结尾，则您的后续调用可以包含 after=obj_foo 以便获取列表的下一页。source

User 对象的列表。source

示例请求

1
2
3
curl https://api.openai.com/v1/organization/users?after=user_abc&limit=20 \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "list",
    "data": [
        {
            "object": "organization.user",
            "id": "user_abc",
            "name": "First Last",
            "email": "user@example.com",
            "role": "owner",
            "added_at": 1711471533
        }
    ],
    "first_id": "user-abc",
    "last_id": "user-xyz",
    "has_more": false
}

修改用户

POST https://api.openai.com/v1/organization/users/{user_id}

修改用户在组织中的角色。source

路径参数

user_id

字符串source

必填

用户的 ID。source

请求正文

角色

字符串source

必填

owner或readersource

更新的 User 对象。source

示例请求

1
2
3
4
5
6
curl -X POST https://api.openai.com/v1/organization/users/user_abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json" \
  -d '{
      "role": "owner"
  }'

响应

{
    "object": "organization.user",
    "id": "user_abc",
    "name": "First Last",
    "email": "user@example.com",
    "role": "owner",
    "added_at": 1711471533
}

检索用户

获取 https://api.openai.com/v1/organization/users/{user_id}

按用户的标识符检索用户。source

路径参数

user_id

字符串source

必填

用户的 ID。source

与指定 ID 匹配的 User 对象。source

示例请求

1
2
3
curl https://api.openai.com/v1/organization/users/user_abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "organization.user",
    "id": "user_abc",
    "name": "First Last",
    "email": "user@example.com",
    "role": "owner",
    "added_at": 1711471533
}

删除用户

删除 https://api.openai.com/v1/organization/users/{user_id}

从组织中删除用户。source

路径参数

user_id

字符串source

必填

用户的 ID。source

确认已删除的用户source

示例请求

1
2
3
curl -X DELETE https://api.openai.com/v1/organization/users/user_abc \
  -H "Authorization: Bearer $OPENAI_ADMIN_KEY" \
  -H "Content-Type: application/json"

响应

{
    "object": "organization.user.deleted",
    "id": "user_abc",
    "deleted": true
}

用户对象

代表个人user在组织内。source

对象

字符串source

对象类型，始终为organization.usersource

身份证

字符串source

标识符，可在 API 端点中引用source

名字

字符串source

用户的名称source

电子邮件

字符串source

用户的电子邮件地址source

角色

字符串source

owner或readersource

added_at

整数source

添加用户时的 Unix 时间戳（以秒为单位）。source

OBJECT 用户对象

1
2
3
4
5
6
7
8
{
    "object": "organization.user",
    "id": "user_abc",
    "name": "First Last",
    "email": "user@example.com",
    "role": "owner",
    "added_at": 1711471533
}