完整文档索引见 llms.txt。在页面 URL 后附加 .md 即可获取 Markdown 版本；本页的 Markdown 版本可在此获取。

用户

用户相关操作

获取所有用户

获取实例中的所有用户，仅实例所有者可用。

GET/users

请求参数

参数	位置	类型	必填	说明
limit	query	number	否	最多返回的数据项数量。 默认值：100
cursor	query	string	否	将 cursor 参数设为上次请求响应中的 nextCursor 属性，以进行分页。使用默认值时，获取集合的第一页。更多信息，请参阅分页说明。
includeRole	query	string	否	默认值："false" 可选值：true, false
projectId	query	string	否

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	指定的 projectId 不存在。

响应结构：200 · application/json

字段	类型	必填	说明
data	array	是	展开字段 字段 类型 必填 说明 data.[]id string 是 只读。 data.[]email string 是 data.[]firstName string 是 只读。 data.[]lastName string 是 只读。 data.[]isPending boolean 是 用户是否已响应邀请并完成账户设置：已完成为 true，未完成为 false。 只读。 data.[]createdAt string 是 只读。 data.[]updatedAt string 是 只读。 data.[]mfaEnabled boolean 是 用户是否启用了多重身份验证（MFA/2FA）。 只读。 data.[]role string 否 只读。
nextCursor	string	是	将 cursor 参数设为先前请求返回的 nextCursor 属性，以对用户进行分页。使用默认值时，获取集合的第一页。

下载完整 OpenAPI 定义（JSON）

创建多个用户

创建一个或多个用户。

POST/users

请求参数

参数	位置	类型	必填	说明
Idempotency-Key	header	string	否	此 POST 请求的安全重试键。使用 1 到 128 个可见 ASCII 字符。相同的键配合相同的请求，会返回首次成功的响应。使用此键发送不同请求时返回 422。首次请求仍在处理时重试，会返回 409。

请求体

application/json

字段	类型	必填	说明
[]email	string	是
[]role	联合类型	否	默认值："global:member" 展开字段 结构 1 结构 2

响应

状态码	说明
201	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
409	冲突
415	不支持的媒体类型。
422	无法处理的实体

响应结构：201 · application/json

字段	类型	必填	说明
[]user	object	是	展开字段 字段 类型 必填 说明 []user.id string 是 只读。 []user.email string 是 []user.inviteAcceptUrl string 否 受邀用户可打开此链接完成账户设置。仅在实例不发送邀请邮件时返回。 只读。 []user.emailSent boolean 是 是否已向用户发送邀请邮件。 只读。 []user.role string 是 只读。
[]error	string	否	此用户的邀请失败原因；邀请成功时为空。 只读。

下载完整 OpenAPI 定义（JSON）

按 ID／邮箱获取用户

获取实例中的某个用户，仅实例所有者可用。

GET/users/{userId}

请求参数

参数	位置	类型	必填	说明
userId	path	string	是	用户的 ID 或邮箱。
includeRole	query	string	否	默认值："false" 可选值：true, false

响应

状态码	说明
200	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	没有具有该 ID 或邮箱的用户。

响应结构：200 · application/json

字段	类型	必填	说明
id	string	是	只读。
email	string	是
firstName	string	是	只读。
lastName	string	是	只读。
isPending	boolean	是	用户是否已响应邀请并完成账户设置：已完成为 true，未完成为 false。 只读。
createdAt	string	是	只读。
updatedAt	string	是	只读。
mfaEnabled	boolean	是	用户是否启用了多重身份验证（MFA/2FA）。 只读。
role	string	否	只读。

下载完整 OpenAPI 定义（JSON）

删除用户

从实例中删除用户。

DELETE/users/{userId}

请求参数

参数	位置	类型	必填	说明
userId	path	string	是	用户的 ID。
transferId	query	string	否	目标项目的 ID，用于接收被删除用户的工作流和凭据。省略时会删除这些资源，不进行转移。

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。

下载完整 OpenAPI 定义（JSON）

更改用户的全局角色

更改用户的全局角色

PATCH/users/{userId}/role

请求参数

参数	位置	类型	必填	说明
userId	path	string	是	用户的 ID。

请求体

application/json

字段	类型	必填	说明
newRoleName	联合类型	是	展开字段 结构 1 结构 2

响应

状态码	说明
204	操作成功。
400	请求无效，或提供的数据格式错误。
401	未授权
403	禁止访问
404	未找到指定资源。
415	不支持的媒体类型。

下载完整 OpenAPI 定义（JSON）