文档首页/ 云空间服务 KooDrive/ API参考/ API/ 用户管理/ 获取用户列表
更新时间：2024-07-30 GMT+08:00
查看PDF
分享

获取用户列表

功能介绍

查询部门下用户列表。当未传入department_id时，查询当前登录用户所在组织的用户列表。

URI

GET /koodrive/ose/v1/userList

表1 Query参数

参数

是否必选

参数类型

描述

deptId

否

String

部门标识

isDirect

否

Boolean

是否为直属用户，默认为false

offset

是

String

偏移量，最小值为0

limit

是

String

最大返回个数。最小值为1，最大值为100

keyWord

否

String

搜索的关键字，可用name作为关键字搜索条件

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Authorization

是

String

该字段存储的是Access Token。调用KooDrive的API使用Token认证，拥有Token就代表拥有某种权限，在调用API的时候将Token加到请求消息头中，从而通过身份认证，获得操作API的权限。Access Token的获取请参考对应的开发手册，格式参考：Bearer+{access_token}

X-Traceid

否

String

消息日志跟踪标识（必须58位）

language

否

String

国际化语言标识，符合i18n规范，如zh-CN表示简体中文，en-US表示美式英语，不传默认美式英语

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

code

String

响应码

msg

String

响应消息

data

Array of userInfo objects

用户信息
表4 userInfo

参数

参数类型

描述

name

String

名称

userId

String

用户Id

deptId

String

部门标识

deptName

String

部门名称

mobile

String

手机号

role

Integer

角色

status

Integer

状态

id

String

用户三方id

请求示例

查询部门1243693141656107521下用户列表，从0开始查询10个用户。

GET /koodrive/ose/v1/userList?deptId=1243693141656107521&offset=0&limit=10

Authorization:Bearer+10f88**********4791e9ff

响应示例

状态码： 200

用户列表信息

{
  "list": [
    {
      "id": "1316083732377071000VW5TYWZlSW50ZWdlcg==",
      "userId": "1008600000293202821",
      "deptId": "1243693141656107500VW5TYWZlSW50ZWdlcg==",
      "deptName": "newDept",
      "mobile": "0086181****8439",
      "name": "小二的测试账号",
      "role": 1,
      "status": 0,
    },
    {
      "id": "1315783852559526700VW5TYWZlSW50ZWdlcg==",
      "userId": "1008600000292227464",
      "deptId": "1243693141656107500VW5TYWZlSW50ZWdlcg==",
      "deptName": "newDept",
      "mobile": "0086151****8338",
      "name": "test123",
      "role": 1,
      "status": 2
    }
  ],
  "total": 2,
  "code": 0,
  "msg": "success"
}

状态码

状态码

描述

200

用户列表信息
父主题： 用户管理