Skip to main content

查询用户列表接口

查询当前应用可访问的组织用户，按关键词、部门、账号状态和席位状态筛选。返回用户标识 qid、基本资料、部门归属及席位状态，可用于定位后续需要修改的用户。

  • Scope：admin.v1.user-directory.read
  • 权限项：用户与部门信息读取（user-directory）
  • 权限类型：读取
  • 接口：GET/api/openapi/v1/users

认证与请求头

使用应用 API Key 调用。当前接口只校验上方独立 Scope；读取、管理与执行权限互不隐含。
名称位置类型必填说明示例
Authorizationheaderstring是应用 API Key，使用 Bearer 方式传递。Bearer qwk_***
X-Request-Idheaderstring否可选的调用追踪标识；未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
third_party_user_idsqueryarray ｜ null否Repeated third-party user IDs (at most 100; each 1-255 characters after trimming). Case-sensitive exact match, intersected with other filters and application user scope. Empty values are rejected. Omit to leave this filter unset.["<string>"]
keywordquerystring否搜索关键词"<string>"
department_idquerystring · uuid否所属部门（部门 ID）"<uuid>"
statusquerystring否用户状态"pending"
seat_statusquerystring否席位授权"assigned"
pagequeryinteger · int64否页码1
page_sizequeryinteger · int64否每页条数20

请求示例

curl --request GET \
  --url 'https://dev-develop.dev-vpc.qwenwork.cn/api/openapi/v1/users?third_party_user_ids=<third_party_user_ids>&keyword=<keyword>&department_id=<department_id>&status=<status>&seat_status=<seat_status>&page=1&page_size=20' \
  --header 'Authorization: Bearer <API_KEY>'

响应

200 OK

名称类型必填说明示例
itemsarray ｜ null是用户列表。-
pageinteger · int64是页码0
page_sizeinteger · int64是每页条数0
totalinteger · int64是总条数0

items[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
accountstring否账号
created_atstring · date-time是用户创建时间。
credentialobject是密码生命周期信息，不包含密码或哈希。
department_idsarray<string> ｜ null是所属部门（部门 ID 列表）
departmentsarray<object>是部门详情；无部门时为空数组。
emailstring否邮箱
job_numberstring否工号
last_active_atstring · date-time否IAM 最近活跃时间；无记录时省略，不等同于最近业务使用时间。
namestring是姓名
phonestring否手机号
qidstring · uuid是用户 ID（QID）；对应用户编辑接口路径中的 userId
seat_statusstring是席位授权；可选值：assigned, unassigned
sourcestring是来源；可选值：manual, directory-sync
statusstring是用户状态；可选值：pending, active, disabled
third_party_user_idstring是第三方用户 ID；未设置时为空字符串。
updated_atstring · date-time是更新时间

items[].credential 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
credential_versioninteger · int64是凭证版本。
first_login_completed_atstring · date-time否首次登录完成时间；未完成时省略。
must_change_passwordboolean是是否需要修改密码。
password_statestring是密码状态：unset 未设置、initial 初始密码、active 已生效；可选值：unset, initial, active
password_updated_atstring · date-time否密码更新时间；无记录时省略。

items[].departments[] 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
external_idstring否第三方部门 ID；对应部门创建、编辑接口的 external_id，未设置时省略
idstring · uuid是部门 ID。
is_primaryboolean是是否为主部门。
namestring是部门名称。
pathstring是部门路径。
{
  "items": [
    {
      "account": "<string>",
      "department_ids": [
        "<string>"
      ],
      "email": "<string>",
      "job_number": "<string>",
      "name": "<string>",
      "phone": "<string>",
      "qid": "<uuid>",
      "seat_status": "assigned",
      "source": "manual",
      "status": "pending",
      "updated_at": "2026-08-27T10:00:00Z",
      "third_party_user_id": "external-001",
      "departments": [
        {
          "id": "22222222-2222-4222-8222-222222222222",
          "name": "Engineering",
          "path": "Company/Engineering",
          "external_id": "external-dept",
          "is_primary": true
        }
      ],
      "credential": {
        "password_state": "active",
        "must_change_password": false,
        "credential_version": 2
      },
      "created_at": "2026-09-19T01:00:00Z",
      "last_active_at": "2026-09-23T01:00:00Z"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0
}

default Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}