获取组织用户
一、接口URL
/umsopenapi/user/list
二、功能
获取组织下的用户,分页
三、请求参数
http header 请求参数
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
token | String | true | http header | 调用全时API的身份验证token |
http body 请求参数
名称 | 类型 | 是否必传 | 传参方式 | 说明 |
---|---|---|---|---|
organizationId | Long | true | RequestBody | 部门Id |
pageNum | int | false | RequestBody | 页码,第几页,默认1 |
pageSize | int | false | RequestBody | 每页返回条数,默认200 |
四、请求体
{
"organizationId":73714881,
"pageNum":1,
"pageSize":10
}
五、返回参数
名称 | 类型 | 说明 |
---|---|---|
code | Integer | 结果码,0: 成功, 非0:失败 (具体描述见错误码表) |
data | json | 返回数据 |
message | String | 错误描述 |
requestId | String | 请求唯一ID。查询接口日志时需要,建议打印日志 |
data
名称 | 类型 | 说明 |
---|---|---|
pageNum | Integer | 页码 |
pageSize | Integer | 每页大小 |
totalCount | Integer | 总数 |
list | List | 用户列表 |
list
名称 | 类型 | 说明 |
---|---|---|
userId | Long | 用户Id |
String | 用户邮箱 | |
loginName | String | 用户账号名 |
mobile | String | 手机号 |
countryCode | String | 国家码 |
name | String | 姓名。 |
position | String | 职务 |
office | String | 办公地点 |
externalUserName | String | 第三方用户id |
jobNumber | String | 工号 |
organizationId | Long | 组织Id |
六、返回体
{
"code": 0,
"msg": "get user list success",
"data": {
"pageNum": 1,
"pageSize": 10,
"totalCount": 2,
"list": [
{
"userId": 88874121,
"email": "yujie12@tfzq.com",
"mobile": "13510220000",
"name": "test",
"position": "",
"office": "",
"sex": null,
"orderFlag": null,
"organizationId": 73879803,
"jobNumber": "00001"
},
{
"userId": 88874122,
"email": "wangzhe12@tfzq.com",
"mobile": "13166035900",
"name": "姓名12",
"position": "",
"office": "",
"sex": null,
"orderFlag": null,
"organizationId": 73879803,
"jobNumber": "00002"
}
]
},
"requestId": "7d31df33-a72a-437b-b00d-ef3f2eeaa82e"
}