跳到主要内容

查询用户列表

GET/v2/users

根据 filter 表达式查询当前组织中的用户，并通过游标进行分页。

过滤条件​

支持的过滤字段为 email、name、nickname、employeeNo、status、domain、employeeType、delegateType、departmentId、jobTitle、workLocation、homeLocation、info、managerId 和 isSharedWithOthers。例如：

  • (departmentId=xxx)：查询部门 xxx 的直属用户，不包含子部门。
  • (departmentId=xxx*)：查询部门 xxx 及其子部门中的用户。
  • (employeeNo=32901)：查询工号等于 32901 的用户。
  • (|(name=Jack)(email=*jack*))：名称为“Jack”，或邮箱地址中包含 jack。
  • (&(employeeType=SERVICE)(email=*abc*))：邮箱地址中包含 abc 的服务账号。
  • (&(departmentId=xxx)(!(status=FREEZE)))：部门 xxx 中状态不是已冻结的用户。
  • (domain=example.com)：属于子域名 example.com 的用户。
  • (delegateType=QUARANTINE)：已建立隔离区授权关系的用户。

排序​

支持按 email、name、nickname、employeeNo 或 createdTime 排序。

Request​

Query parameters

    filter string

    过滤表达式

    cursor string

    查询游标，不填则从头开始

    size number

    分页大小，最大不超过 100

    orderby string

    排序字段，不填则按 创建时间 倒排

    order enum

    Possible values: [ASC, DES]

    • ASC:
    • DES:
    managed boolean

    仅返回管理的用户，该字段仅管理员角色有效

    $select string

响应

    users object[]
    id string

    用户 id，

    email stringrequired

    展示使用的邮件地址，只能设置为别名列表其中之一

    emailAliases string[]

    邮件地址别名列表

    name stringrequired

    用户名(人名)

    nickname string

    用户昵称(或者花名)

    employeeNo string

    工号

    jobTitle string

    职位

    workLocation string

    工作地

    officeLocation string

    工位

    departmentIds string[]required

    用户所属的部门(列表)，非部门链，用户可能同时隶属多个部门

    status enum

    帐号状态（仅正常或冻结），仅管理员或授权应用可修改

    • NORMAL: 正常
    • FREEZE: 被冻结

    Possible values: [NORMAL, FREEZE]

    avatar object

    头像

    url string

    头像地址

    bgColor string

    头像地址空时，背景色值，示例: #0089ff

    freezedTime string<date-time>

    冻结时间，管理员或授权应用可读取（可选字段：在URL中增加$select=freezedTime查询参数后返回，如需多个字段使用英文逗号分隔）

    managerInfo object

    主管详情（可选字段：在URL中增加$select=managerInfo查询参数后返回，如需多个字段使用英文逗号分隔）

    id string

    主管id

    email string

    主管邮件地址

    name string

    姓名

    nickname string

    昵称

    managerEmail string

    主管 email，可写（可选字段：在URL中增加$select=managerEmail查询参数后返回，如需多个字段使用英文逗号分隔）

    orderInDepartments object[]

    账号在不同部门下的排序值，必须提供全量部门的排序值数据。该字段会影响账号在其他部门的排序，一般场景优先使用设置单个部门排序值的接口。例如账号归属部门a、b、c，账号原只有部门c的排序值。更新账号在该字段传入部门a和b的排序值后，账号将只有部门a和b的排序值，原有部门c的排序值将丢失。仅管理员或授权应用可访问，可修改（可选字段：在URL中增加$select=orderInDepartments查询参数后返回，如需多个字段使用英文逗号分隔）

    departmentId string
    order string
    nextCursor string
    hasMore boolean

错误

401

访问未授权，请检查是否传递了正确的授权token

403

无API访问权限，请在域管的应用管理页面完成相关授权