接口功能介绍
查询用户列表
接口约束
无
URI
GET /v3/user/describe
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 资源池ID。 | d8bbd132b53a11e9b0e40242ac110002 | |
| orgOid | 否 | String | 部门Oid，默认为根部门 | null | |
| querySubOrg | 否 | Boolean | 是否包含下级部门。默认为false。 | false | |
| userName | 否 | String | 用户名称 | null | |
| 否 | String | 通知邮箱 | null | ||
| userAccount | 否 | String | 用户账号 | null | |
| pubUserOids | 否 | String | 用户ID。取值由用户ID组成一个JSON数组，最多支持10个ID，ID之间用半角逗号（,）隔开。 | null | |
| pageNum | 否 | Integer | 页码，至少1，默认1 | 1 | |
| pageSize | 否 | Integer | 每页数量，最大100，默认10 | 10 |
请求参数
请求头header参数
无
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 状态码。可能值： - 800：请求成功。 - 900：请求失败。 |
800 | |
| error | String | 错误码。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回数据对象 | returnObj |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Long | 总记录数 | 1 | |
| list | Array of Objects | 数据列表 | list |
表 list
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| pubUserOid | String | 用户ID | upg-0bmy2g88j0dp19ym5lvj6 | |
| orgOid | String | 部门ID | org-adhij4zha35v3knu9irlg | |
| String | 通知邮箱 | null | ||
| gender | String | 性别 | null | |
| telephone | String | 固定电话 | null | |
| position | String | 职位 | null | |
| userName | String | 用户名 | xiemushutest2 | |
| desktopNums | Integer | 云电脑数量 | 1 | |
| status | Byte | 状态（1-有效，3-待确认） | 1 | |
| loginAccount | String | 登录账户 | xiemushutest2#3803 | |
| userAccount | String | 用户账户 | xiemushutest2 | |
| lockStatus | Byte | 锁定状态(0-未锁定;1-锁定) | 0 |
枚举参数
无
请求示例
请求url
无
请求头header
无
请求体body
无
响应示例
{"statusCode":800,"message":"OK.","returnObj":{"total":1,"list":[{"pubUserOid":"upg-xxx","orgOid":"org-foo","email":"foo@foo.com","gender":"男","telephone":"xxxxxxxx","position":"xxxxxxxxx","userName":"foo","desktopNums":0,"status":1,"loginAccount":"foo#id","userAccount":"foo","lockStatus":0}]}}
状态码
请参考 状态码
错误码
请参考 错误码
