根据账号关键字、组织编号和角色码分页查询用户账号 分页查询比较耗时,超时时间调整为6000ms
路径 | /industry/user/account/query |
版本号 | 1.0.7 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 6000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
keyWord | String | 否 | 账号搜索关键字 | |
organizationId | String | 否 | 组织ID | |
roleCode | String | 否 | 角色码 | |
pageNo | Int | 否 | 分页号,缺省为1 | |
pageSize | Int | 否 | 分页大小,缺省为10 | |
appId | String | 否 | 应用实例ID,共享式多租户saas应用该参数为必填,否则无法定位到购买者租户ID | |
employeeId | String | 否 | 员工ID,独立式托管应用场景为员工账号的empId;共享式多租户应用场景为tanantSubUserId;不填默认当主账号身份; |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码, 200: 成功 |
|
message | String |
错误消息 |
|
localizedMsg | String |
本地语言错误消息 |
|
data | JSON |
响应结果 |
|
total | Int |
总记录数 |
|
pageNo | Int |
当前页 |
|
pageSize | Int |
每页记录数 |
|
data | JSON |
查询结果 |
|
organizationId | String |
组织ID |
|
organizationShowName | String |
组织名称 |
|
roleCode | String |
角色码,废弃参数不推荐使用,请参考新参数roleList。 |
|
roleName | String |
角色名称,废弃参数不推荐使用,请参考新参数roleList。 |
|
auid | String |
用户ID |
|
phone | String |
手机号码 |
|
String |
电子邮箱 |
||
nickName | String |
用户名称 |
|
roleList | JSON |
授予账号的角色列表 |
|
roleCode | String |
角色码 |
|
roleName | String |
角色名称 |
|
orgList | JSON |
人员加入的组织列表 |
|
organizationId | String |
组织ID |
|
organizationName | String |
组织名称 |
|
admin | Boolean |
是否系统管理员 |
|
main | Boolean |
是否员工主账号 |
|
workNumber | String |
人员主数据ID,即员工工号 |
|
loginName | String |
登录账号 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.7"
},
"params":{
"keyWord": "value0",
"organizationId": "value1",
"roleCode": "value2",
"pageNo": "value3",
"pageSize": "value4",
"appId": "value5",
"employeeId": "value6"
}
}
正常返回示例
JSON
格式
{
"id": "70333b89-3302-4006-8559-cf6d345ae52c",
"code": 200,
"message": null,
"localizedMsg": null,
"data": {
"total": 2,
"pageNo": 1,
"pageSize": 20,
"data": [
{
"organizationId": "xxxxxxxx",
"organizationShowName": "研发部",
"roleCode": "ADMINISTRATOR",
"roleName": "系统集成商",
"auid": "505c689bf68dc13e35eee32b00e52d652c283946",
"phone": "xxxxx",
"email": "test_1@taobao.com",
"nickName": "tpc",
"admin":false,
"main":false,
"roleList": [
{
"roleCode": "ADMINISTRATOR",
"roleName": "系统集成商"
}
],
"orgList": [
{
"organizationId": "xxxxxx",
"organizationName": "研发部"
}
]
},
{
"organizationId": null,
"organizationShowName": null,
"roleCode": null,
"roleName": null,
"auid": "5011683d8137ba44ea44173580980012e6872112",
"phone": "xxxxx",
"email": "test_2@taobao.com",
"nickName": "权限测试",
"admin":false,
"main":false,
"roleList": [
{
"roleCode": "e818594a302c4e1fdc2d032a3dc680d2",
"roleName": "新建角色"
}
],
"orgList": [
{
"organizationId": "xxxxxx",
"organizationName": "研发部"
}
]
}
]
}
}
异常返回示例
JSON
格式
{
"id": "70333b89-3302-4006-8559-cf6d345ae52c",
"code": 200,
"message": "request forbidden.",
"localizedMsg": "请求没有权限",
"data": null
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
500 | 500 | Internal Error | Internal Error |
503 | 503 | Service Unavailable | Service Unavailable |
403 | 403 | Request Limited | Request Limited |
401 | 401 | Empty Signature | Empty Signature |
400 | 400 | Request Format Error | Request Format Error |
200 | 20003 | Find Backend Error | Find Backend Error |
200 | 20004 | Backend Service Error | Backend Service Error |
200 | 20055 | Backend Service Invalid | Request Format Error |
200 | 20056 | Hsf Invoke Timeout | Hsf Invoke Timeout |
200 | 401 | Request Authorized Error | Request Authorized Error |
200 | 403 | Request Forbidden | Request Forbidden |
200 | 500 | Server Error | Server Error |
200 | 403 | request forbidden. | 请求没有权限 |