查看用户列表

分页查看当前工作区中的用户和待处理邀请,可按名称、说明或成员状态筛选。

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

调用前准备

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

请求参数

curl -X POST "https://api.moi.matrixorigin.cn/v5/user/list" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "page": 1,
    "page_size": 20
  }'

参数

类型

是否必填

说明

page

integer

页码。

page_size

integer

每页数量。

filters

array

筛选条件。

filters[].name

string

筛选字段:name、name_description 或 status。

filters[].values

array of string

筛选值;服务端使用每项的第一个值。

name 按用户名进行不区分大小写的包含匹配;name_description 同时匹配用户名和说明;status 按状态精确匹配。读取下一页时将 page 加 1 并保留相同筛选条件;累计读取数量达到响应中的 data.total,或当前页 data.user_list 为空时停止。

成功响应

成功时返回符合筛选条件的用户总数和当前页数据。待处理邀请也可能出现在列表中,其状态为 pending。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "total": 1,
    "user_list": [
      {
        "id": "user-001",
        "iam_user_id": "iam-user-001",
        "name": "data_analyst",
        "status": "enabled",
        "created_at": "2026-08-01T09:00:00Z",
        "updated_at": "2026-08-21T09:00:00Z",
        "reserved": false,
        "role_list": [],
        "tag_list": []
      }
    ]
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.total

integer

符合筛选条件的用户总数。

data.user_list

array

当前页的用户和待处理邀请。

data.user_list[].id

string

用户在账户系统中的 ID;待处理邀请尚未完成映射时可能为空。

data.user_list[].iam_user_id

string

IAM 用户 ID。

data.user_list[].name

string

用户在工作区中的名称。

data.user_list[].description

string

用户说明;无值时省略。

data.user_list[].status

string

用户状态:enabled、disabled 或 pending。

data.user_list[].created_at

string

创建时间,使用 RFC 3339 格式。

data.user_list[].updated_at

string

更新时间,使用 RFC 3339 格式。

data.user_list[].reserved

boolean

是否为保留用户。

data.user_list[].role_list

array

用户的直接角色。

data.user_list[].tag_list

array

用户标签。

data.user_list[].github_login

string

GitHub 登录名;无值时省略。

错误响应

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

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

后续操作

选择用户

对用户更新、删除、状态变更、角色绑定或操作记录查看,选择已完成邀请的用户。仍在等待接受邀请的条目不能用于后续用户管理操作。

确认邀请状态

创建用户后,查看列表确认邀请是否已转为可管理的工作区用户。只有已完成邀请的用户才能继续进行更新、删除、角色绑定或操作记录查看。

最后更新于