更新用户信息

更新指定用户在工作区中的名称、说明和标签。本操作按提交内容完整更新用户资料;未保留的说明或标签会被清空。

POST https://api.moi.matrixorigin.cn/v5/user/update_info

调用前准备

先选择用户。如需保留或调整标签,再选择用户标签。确认提交内容包含希望保留的用户说明和标签。

准备具有目标工作区相应权限的个人访问令牌和目标工作区 ID。

请求参数

curl -X POST "https://api.moi.matrixorigin.cn/v5/user/update_info" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "user-001"
  }'

参数

类型

是否必填

说明

id

string

是

用户 ID。

name

string

是

用户名称。

description

string

否

更新后的用户说明;省略时按空字符串处理。

tag_list

array of object

否

更新后的完整标签列表;省略时按空列表处理。

tag_list[].id

integer

是

标签 ID。

tag_list[].value

string

是

标签值。

成功响应

成功时用户名称、说明和标签已按请求内容更新,响应中的 data 为 null。

{
  "code": "OK",
  "msg": "OK",
  "data": null
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data

null

成功时固定为 null。

错误响应

{
  "code": "INVALID_ARGUMENT",
  "msg": "请求参数无效",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

—

最后更新于