用户组织管理

版本说明

版本	更新时间	更新负责人	更新内容
v1.0		陈紫建
v1.1	2022-06-16	彭业庆	接口2，3，4新增返回字段：行政区划编码：areaCode；行政区划名称：areaName；统一信用代码：unifiedSocialCreditCode；

java

//引入接口平台依赖包
<dependency>
    <groupId>cn.com.digitalhainan</groupId>
    <artifactId>apione-http-client</artifactId>
    <version>hzt-1.0.11-RELEASE</version>
</dependency>

或者通过导入依赖包：apione-http-client-hzt-1.0.11-RELEASE.jar

根据用户id，或外部用户id，或手机号，或账号获取用户详情

接口名称	根据用户id，或外部用户id，或手机号，或账号获取用户详情
接口描述	根据用户id，或外部用户id，或手机号，或账号获取用户详情
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	pushUserInfoTest
生产API名称	pushUserInfo
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
userId	用户id	String	否	必须存在一个参数，且只能有一个参数
externalId	外部id	String	否
account	账号	String	否
phone	手机号	String	否

请求示例

java

String contentJson = "{\"phone\":\"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "pushUserInfoTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();	
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填	备注
userId	用户id	String	否
account	账户	String	否
nickName	显示名称	String	否
phone	手机号	String	否
email	邮箱	String	否
certType	证件类型	String	否
certNo	证件号码	String	否
extendMap	扩展属性	String	否	json字符串，这里面可以取到海政通userId，取key=dingAccountId对应的值即可
enable	是否启用	Boolean	否
externalId	外部用户id	String	否
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss

成功返回示例

json

{
  "code": "0",
  "data": {
    "account": "abc",
    "certNo": "460102190009871234",
    "certType": "id_card",
    "email": "xx@qq.com",
    "enable": true,
    "extendMap": "{\\"sex\\": \\"M\\"}",
    "nickName": "abc",
    "phone": "13533612316",
    "userId": "12344",
    "enable": true,
    "externalId": "",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "updateTime": "yyyy-MM-dd HH:mm:ss"
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据组织id，或外部组织id获取组织详情

接口名称	根据组织id，或外部组织id获取组织详情
接口描述	根据组织id，或外部组织id获取组织详情
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	pushOrgInfoTest
生产API名称	pushOrgInfo
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
orgId	组织id	String	否	必须存在一个参数，且只能有一个参数
externalId	外部组织id	String	否

请求示例

java

String contentJson = "{\"orgId\":\"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "pushOrgInfoTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();	
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填	备注
orgId	组织id	String	否
orgName	组织名称	String	否
externalId	组织外部id	String	否
parentOrgId	组织父级id	String	否
sortNum	排序号	Int	否
leaf	是否叶子节点	Boolean	否
extendMap	扩展属性	String	否	json字符串
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织
enable	是否启用	Boolean	否
unitId	单位id	String	否
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否

成功返回示例

json

{
  "code": "0",
  "data": {
    "enable": true,
    "extendMap": "{}",
    "externalId": "123456",
    "leaf": false,
    "orgId": "123456",
    "orgName": "海口市教育局",
    "parentOrgId": "1",
    "remark": "",
    "sortNum": 1,
    "orgType": "GOV_VIRTUAL",
    "unitId": "xxx",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "updateTime": "yyyy-MM-dd HH:mm:ss",
    "areaCode": "",
    "areaName": "",
    "unifiedSocialCreditCode": ""
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

获取组织顶级节点

接口名称	获取组织顶级节点
接口描述	获取组织顶级节点
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	pushOrgRootInfoTest
生产API名称	pushOrgRootInfo
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

请求示例

java

String contentJson = "{}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "pushOrgRootInfoTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();	
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填	备注
orgs	组织列表	Array	否
orgId	组织id	String	否
orgName	组织名称	String	否
externalId	组织外部id	String	否
parentOrgId	组织父级id	String	否
sortNum	排序号	Int	否
leaf	是否叶子节点	Boolean	否
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织
enable	是否启用	Boolean	否
unitId	单位id	String	否
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否

成功返回示例

json

{
  "code": "0",
  "data": {
    "orgs":[
      {
        "enable": true,
        "externalId": "xxxx",
        "leaf": false,
        "orgId": "1",
        "orgName": "xxxx",
        "parentOrgId": "0",
        "sortNum": 1,
        "orgType": "GOV_VIRTUAL",
        "unitId": "xxxx",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "areaCode": "",
        "areaName": "",
        "unifiedSocialCreditCode": ""
      }
    ]
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据父级id，或外部父级id获取下级组织分页列表

接口名称	根据父级id，或外部父级id获取下级组织分页列表
接口描述	根据父级id，或外部父级id获取下级组织分页列表
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	pushOrgChildTest
生产API名称	pushOrgChild
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
pageNum	第几页	Int	否	默认：1
pageSize	一页返回多少条记录	Int	否	最大值100
parentId	组织的父级id	String	否	parent 和 parentExternalId 只能存在一个
parentExternalId	组织的父级外部id	String	否

请求示例

java

String contentJson = "{\"parentId\":\"\",\"pageNum\":1,\"pageSize\":10}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "pushOrgChildTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();	
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填
pageNum	第几页	Int	否
pageSize	一页返回多少条记录	Int	否
pages	总页数	Int	否
total	总记录数	Int	否
records	记录数据	List	否

records字段	字段说明	类型	必填	备注
orgId	组织id	String	否
orgName	组织名称	String	否
parentOrgId	父级组织id	String	否
externalId	外部数据id	String	否
leaf	是否叶子节点	Boolean	否
enable	是否启用	Boolean	否
sortNum	序号	Int	否
remark	备注	String	否
unitId	单位id	String	否
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否

成功返回示例

json

{
  "code": "0",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "pages": 2,
    "records": [{
      "enable": true,
      "externalId": "12345",
      "leaf": false,
      "orgId": "12345",
      "orgName": "龙华区教育局",
      "parentOrgId": "xxx",
      "remark": "",
      "sortNum": 1,
      "orgType": "GOV_VIRTUAL",
      "unitId": "xxx",
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss",
      "areaCode": "",
      "areaName": "",
      "unifiedSocialCreditCode": ""
    }],
    "total": 15
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据组织id分页获取人员信息

接口名称	根据组织id分页获取人员信息
接口描述	根据组织id分页获取人员信息
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	pushOrgUsersTest
生产API名称	pushOrgUsers
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
pageNum	第几页	Int	否	默认：1
pageSize	一页返回多少条记录	Int	否	最大值100
orgId	组织id	String	否	orgId 和 orgExternalId 只能存在一个
orgExternalId	组织外部id	String	否
nickName	名称	String	否	支持右模糊搜索

请求示例

java

String contentJson = "{\"orgId\":\"\",\"pageNum\":1,\"pageSize\":10}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "pushOrgUsersTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填
pageNum	第几页	Int	否
pageSize	一页返回多少条记录	Int	否
pages	总页数	Int	否
total	总记录数	Int	否
records	记录数据	List	否

records字段	字段说明	类型	必填	备注
userId	用户id	String	否
account	账号	String	否
phone	手机号	String	否
email	邮箱	String	否
nickName	可展示名称	String	否
remark	备注	String	否
enable	是否启用	Boolean	否
jobType	任职类型：1-主职、2-兼职	Integer	否
posJob	职务	String	否
sortNum	排序码	Integer	否
mainJob	是否主职	Boolean	否
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss

成功返回示例

json

{
  "code": "0",
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "pages": 1,
    "records": [{
      "account": "testcity",
      "nickName": "测试市教育局",
      "phone": "13500999999",
      "userId": "xxx",
      "email": "",
      "enable": true,
      "remark": "xx",
      "jobType": 1, 
      "posJob": "", 
      "sortNum": 2, 
      "mainJob":false, 
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss"
    }, {
      "account": "hanhaoyu",
      "nickName": "abc",
      "phone": "",
      "userId": "23333",
      "email": "",
      "enable": true,
      "remark": "xx",
      "jobType": 1, 
      "posJob": "", 
      "sortNum": 2, 
      "mainJob":false,
      "createTime": "yyyy-MM-dd HH:mm:ss",
      "updateTime": "yyyy-MM-dd HH:mm:ss"
    }],
    "total": 2
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

获取组织的单位信息

接口名称	获取组织的单位信息
接口描述	获取组织的单位信息
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	orgUnitTest
生产API名称	orgUnit
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
orgId	组织id	String	是

请求示例

java

String contentJson = "{\"orgId\": \"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "orgUnitTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填
orgId	组织id	String	是
orgName	组织名称	String	是
orgType	组织类型	String	是
pathFullName	组织全路径	String	是
areaCode	区划码	String	是
areaName	区划名称	String	是
unifiedSocialCreditCode	统一社会信用代码	String	是

成功返回示例

json

{
    "success": true,
    "code": "0",
    "message": null,
    "data":{
                "orgId": "14713076945537105935780909906",
                "orgName": "海口市商务局",
                "orgType": null,
                "pathFullName": "",
                "areaCode": "",
                "unifiedSocialCreditCode": null,
                "areaName": null
          },
    "extend": null,
    "debugMessage": "",
    "debugTrace": null,
    "requestId": "3d540c355c03405f9a5e22052a573a12"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据角色查询用户详情列表

接口名称	根据角色查询用户详情列表
接口描述	根据角色查询用户详情列表
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	userInfoByRoleTest
生产API名称	userInfoByRole
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
roleId	角色id	String	否	角色id和角色code必须存在一个
roleCode	角色code	String	否
pageNum	第几页	Integer	否	默认：1
pageSize	一页返回多少条记录	Integer	否	最大值100

请求示例

java

String contentJson = "{\"roleId\": \"\", \"roleCode\": \"\", \"pageNum\": 1, \"pageSize\": 10}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "userInfoByRoleTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	List	否	返回成功data有内容

data字段	字段说明	类型	必填
pageNum	第几页	Integer	是
pageSize	一页返回多少条记录	Integer	是
pages	总页数	Integer	是
total	记录总数	Integer	是
records	记录数据	List	是

record字段	字段说明	类型	必填
userId	用户id	String	是
account	用户名	String	是
nickName	姓名	String	是
enable	禁用/启用	Boolean	是
remark	备注	String	是
phone	手机号	String	是
email	邮箱	String	是

成功返回示例

json

{
    "success": true,
    "code": "0",
    "message": null,
    "data":{
                "pageNum": 1,
                "pageSize": 20,
                "pages": 1,
                "total": 100,
                "record": [
                  {
                    "userId": "",
                    "account": "",
                    "nickName": "",
                    "enable": true,
                    "remark": "",
                    "phone": "",
                    "email": ""
                  }
                ]
          },
    "extend": null,
    "debugMessage": "",
    "debugTrace": null,
    "requestId": "3d540c355c03405f9a5e22052a573a12"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

组织信息搜索

接口名称	组织信息搜索
接口描述	组织信息搜索
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	orgSearchTest
生产API名称	orgSearch
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
keyword	关键词搜索	String	否
keywordType	关键词类型	String	否	默认为：NAME - 搜索组织名称<br/>FULL_NAME_PATH-组织路径名称模糊搜索<br/>ORG_TYPE-组织类型<br/>UNIFIED_SOCIAL_CREDIT_CODE-组织信用代码
includeOrgIdScope	包含的组织id集	List<String>	否
excludeOrgIdScope	不包含的组织id集	List<String>	否
includeDirectOrgIdScope	搜索当前组织	List<String>	否
pageNum	第几页	int	否
pageSize	一页返回多少条记录	int	否	最大值100

请求示例

java

String contentJson = "{\"keyword\": \"\", \"keywordType\": \"\", \"includeOrgIdScope\": [], \"excludeOrgIdScope\": [], \"includeDirectOrgIdScope\": []}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "orgSearchTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	List	否	返回成功data有内容

data字段	字段说明	类型	必填
pageNum	第几页	Integer	是
pageSize	一页返回多少条记录	Integer	是
pages	总页数	Integer	是
total	记录总数	Integer	是
records	记录数据	List	是

records字段	字段说明	类型	必填	备注
orgId	组织id	String	否
orgName	组织名称	String	否
parentOrgId	组织父级id	String	否
fullNamePath	当前机构完整名称路径	String	否
parentIdPath	父级id路径	String	否
enable	是否启用	Boolean	否
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织

成功返回示例

json

{
  "success": true,
  "code": "0",
  "message": null,
  "data":{
    "pageNum": 1,
    "pageSize": 20,
    "pages": 1,
    "total": 100,
    "record": [
      {
        "orgId": "14713076945537105935780909906",
        "orgName": "海口市商务局",
        "parentOrgId": "14688437621151662099702937959",
        "fullNamePath": "业务中台/惠企政策组织/海口市商务局",
        "parentIdPath": "1,14688437621151662099702937959",
        "enable": true,
        "orgType": ""
      }
    ]
  } ,
  "extend": null,
  "debugMessage": "",
  "debugTrace": null,
  "requestId": "3d540c355c03405f9a5e22052a573a12"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据人员id列表获取人员基本信息列表

接口名称	根据人员id列表获取人员基本信息列表
接口描述	根据人员id列表获取人员基本信息列表
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	listUserInfoWithUserIdTest
生产API名称	listUserInfoWithUserId
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
userIds	用户Id列表	List<String>	是	最大传入100个

请求示例

java

String contentJson = "{\"userIds\": []}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "listUserInfoWithUserIdTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填	备注
users	用户基本信息集合	List<Object>	否

users对象字段	字段说明	类型	必填
users	用户基本信息集合	List<Object>	否
userId	用户id	String	否
account	账号	String	否
nickName	名称	String	否
channel	用户渠道	String	否
certType	证件类型	String	否
certNo	证件号	String	否
userType	用户类型	Integer	否
areaCode	区划编码	String	否
areaName	区划名称	String	否
superManager	是否是超管	Boolean	否
createTime	创建时间	Date	否
updateTime	更新时间	Date	否
enable	是否启用	Boolean	否

成功返回示例

json

{
  "success": true,
  "code": "0",
  "message": null,
  "data": {
    "users": [
      {
        "userId": "17218061175378657301015677196",
        "account": "",
        "nickName": "aaa",
        "phone": "",
        "email": "",
        "certType": "",
        "certNo": "",
        "channel": "sys",
        "externalId": null,
        "password": null,
        "enable": true,
        "createTime": "2023-11-07T08:25:43.000+0000",
        "updateTime": "2023-11-07T08:25:43.000+0000",
        "userType": null,
        "areaCode": null,
        "areaName": null,
        "superManager": null,
        "extendMap": null
      }
    ]
  },
  "extend": null,
  "debugMessage": "",
  "debugTrace": null,
  "requestId": "ff70f6118ccb4508bb22fb1c3a9e1701"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据用户id获取用户信息

接口名称	根据用户id获取用户信息
接口描述	根据用户id获取用户信息
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	getUserInfoByIdTest
生产API名称	getUserInfoById
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
userId	用户id	Strring	是

请求示例

java

String contentJson = "{\"userId\": \"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "getUserInfoByIdTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填
userId	用户id	String	否
account	账号	String	否
nickName	昵称	String	否
phone	手机号	String	否
email	邮箱	String	否
certType	证件类型	String	否
certNo	证件号	String	否
channel	渠道	String	否
externalId	外部id	String	否
password	密码	String	否
enable	是否启用	Boolean	否
createTime	创建时间	Date	否
updateTime	更新时间	Date	否
userType	用户类型	Integer	否
areaCode	区划编码	String	否
areaName	区划名称	String	否
superManager	是否超级管理员	Boolean	否
extendMap	用户扩展属性	Map	否

成功返回示例

json

{
  "code": "0",
  "data": {
    "userId":"",
    "account":"",
    "nickName":"",
    "phone":"",
    "email":"",
    "certType":"",
    "certNo":"",
    "channel":"sys",
    "externalId":"",
    "password":"",
    "enable": true,
    "createTime":"",
    "updateTime":"",
    "userType": 1,
    "areaCode":"",
    "areaName":"",
    "superManager": true,
    "extendMap":{
      "a":"1"
    }
  },
  "message": "",
  "debugMessage": "",
  "debugTrace": "",
  "success": true,
  "extend": null,
  "requestId": "123"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": null
}

获取用户所在的组织信息

接口名称	获取用户所在的组织信息
接口描述	获取用户所在的组织信息
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	uaaGetUserOrgListByIdTest
生产API名称	uaaGetUserOrgListById
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填	备注
userId	用户id	Strring	是

请求示例

java

String contentJson = "{\"userId\": \"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "getUserInfoByIdTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填	备注
orgs	组织列表	Array	否
orgId	组织id	String	否
orgName	组织名称	String	否
externalId	组织外部id	String	否
parentOrgId	组织父级id	String	否
sortNum	排序号	Int	否
leaf	是否叶子节点	Boolean	否
parentIdPath	父级id路径<br/>	String	否
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织
enable	是否启用	Boolean	否
unitId	单位id	String	否
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否
mainJob	是否主职	Boolean	否

成功返回示例

json

{
  "code": "0",
  "data": {
    "orgs":[
      {
        "enable": true,
        "externalId": "xxxx",
        "leaf": false,
        "orgId": "1",
        "orgName": "xxxx",
        "parentOrgId": "0",
        "sortNum": 1,
        "orgType": "GOV_VIRTUAL",
        "unitId": "xxxx",
        "createTime": "yyyy-MM-dd HH:mm:ss",
        "updateTime": "yyyy-MM-dd HH:mm:ss",
        "areaCode": "",
        "areaName": "",
        "unifiedSocialCreditCode": "",
        "mainJob":true
      }
    ]
  },
  "debugMessage": "",
  "success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

通过组织id列表获取组织

接口名称	通过组织id列表获取组织
接口描述	通过组织id列表获取组织
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	uaaGetOrgListByIdsTest
生产API名称	uaaGetOrgListByIds
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

Body	字段说明	类型	必填	备注
orgIds	组织id列表	List<String>	是	最多传入100个

请求示例

json

String content = "{\"orgIds\": []}";
String ak = "";
String sk = "";
String api = "uaaGetOrgListByIdsTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Authorization", "Bearer xxxx");
header.put("Uaa-App-Key", "xx");	
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
        .api(api)
        .headerParamsMap(header)
        .region(region)
        .accessKey(ak)
        .secretKey(sk)
        .contentBody(contentBody)
        .requestUrl(requestUrl)
        .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	List<Object>	否

data字段	字段说明	类型	必填	备注
orgId	组织id	String	否
orgName	组织名称	String	否
parentOrgId	父级组织id	String	否
externalId	外部数据id	String	否
leaf	是否叶子节点	Boolean	否
enable	是否启用	Boolean	否
sortNum	序号	Int	否
remark	备注	String	否
unitId	单位id	String	否
orgType	组织类型	String	否	组织类型；GOV_HOLLOW_STRIP_NODE：条线虚节点；GOV_UNIT：单位；GOV_HOLLOW_DIVISION_NODE：行政区划虚节点；GOV_INTERNAL_INSTITUTION：内设机构；GOV_VIRTUAL：虚拟组织
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss
updateTime	更新时间	String	是	yyyy-MM-dd HH:mm:ss
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否

成功返回示例

json

{
  "code": "0",
  "data": [{
    "enable": true,
    "externalId": "12345",
    "leaf": false,
    "orgId": "12345",
    "orgName": "龙华区教育局",
    "parentOrgId": "xxx",
    "remark": "",
    "sortNum": 1,
    "orgType": "GOV_VIRTUAL",
    "unitId": "xxx",
    "createTime": "yyyy-MM-dd HH:mm:ss",
    "updateTime": "yyyy-MM-dd HH:mm:ss",
    "areaCode": "",
    "areaName": "",
    "unifiedSocialCreditCode": ""
  }]
},
"debugMessage": "",
"success": true
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": {}
}

根据用户扩展属性查询用户信息

接口名称	根据用户扩展属性查询用户信息
接口描述	根据用户扩展属性查询用户信息
接口地址	https://api-one.digitalhainan.com.cn/apione
测试API名称	searchByExtendPropTest
生产API名称	searchByExtendProp
API版本
调用方式
http方法	POST
是否需要鉴权	是，授权账号参照账号信息文件
提供方	统一认证系统
目前在用渠道
废弃日期

请求参数

Header	字段说明	类型	必填	备注
Uaa-App-Key	统一认证应用的ak	String	是
Uaa-Tenant-Id	租户id	String	是	默认：1

字段名称	字段说明	字段类型	必填
pageNum	当前页	Integer	是
pageSize	记录数	Integer	是
extendKey	扩展属性key	String	是
extendValue	扩展属性value	String	是

请求示例

java

String contentJson = "{\"pageNum\": 1, \"pageSize\": 10, \"extendKey\":\"accountId\", \"extendValue\":\"v\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "searchUserByExtendPropTest";
String region = "INTER";
String requestUrl = "https://api-one.digitalhainan.com.cn/apione";
ContentBody contentBody = new ContentBody(contentJson);
Map<String, String> header = new HashMap<>();
header.put("Uaa-App-Key", "xx");	// xx需要替换成统一认证平台的appKey
header.put("Uaa-Tenant-Id", "1");
//拼装业务信息
HttpParameters parameters = HttpParameters.builder()
    .api(api)
    .headerParamsMap(header)	
    .region(region)
    .accessKey(ak)
    .secretKey(sk)
    .contentBody(contentBody)
    .requestUrl(requestUrl)
    .build();
//请求开发服务，获取response
HttpReturn call = HttpCaller.getInstance().call(parameters);

返回参数

返回参数	字段说明	类型	必填	备注
requestId	请求Id	String	是
success	状态码	Boolean	是	状态码： true表示成功 false表示失败
code	错误码	String	否
message	响应消息	String	否
extend	扩展响应内容	Object	否
debugMessage	异常信息	String	否	测试环境才返回，方便接口调试错误排查
debugTrace	异常堆栈信息	String	否	测试环境才返回，方便接口调试错误排查
data	返回内容	Object	否	返回成功data有内容

data字段	字段说明	类型	必填
pageNum	当前页	Integer	否
pageSize	记录数	Integer	否
pages	分页数	Integer	否
total	记录总数	Integer	否
records	记录	List<Object>	否

records	字段说明	类型	必填
id	主键标识	String	是
userId	用户id	String	是
account	账号	String	是
nickName	昵称	String	是
phone	手机号	String	是
belongs	职务信息	List<Object>	是

belongs	字段说明	类型	必填
orgId	机构id	String	是
orgName	机构名称	String	是
posJob	职位	String	是
fullNamePath	机构全路径名	String	是
jobType	职务类型	String	是
mainJob	是否主职	Boolean	是

成功返回示例

json

{
  "code": "0",
  "data": {
    "latestId": "",
    "result": [
      {
        "id":"",
        "userId":"",
        "account":"",
        "nickName":"",
        "phone":"",
        "belongs":[
          {
            "orgId":"",
            "orgName":"",
            "posJob":"",
            "fullNamePath":""
            "jobType": "",
            "mainJob": true
          }
        ]
      }
    ]
  },
  "message": "",
  "debugMessage": "",
  "debugTrace": "",
  "success": true,
  "extend": null,
  "requestId": "123"
}

失败返回示例

json

{
  "requestId": "15902051813530044359",
  "success": false,
  "code": "ERR_DATA_NOT_FOUND",
  "message": "数据不存在",
  "debugMessage": "",
  "debugTrace": "",
  "extend": null
}

用户组织管理 ​

版本说明 ​

根据用户id，或外部用户id，或手机号，或账号获取用户详情 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据组织id，或外部组织id获取组织详情 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取组织顶级节点 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据父级id，或外部父级id获取下级组织分页列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据组织id分页获取人员信息 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取组织的单位信息 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据角色查询用户详情列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

组织信息搜索 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据人员id列表获取人员基本信息列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据用户id获取用户信息 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取用户所在的组织信息 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

通过组织id列表获取组织 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据用户扩展属性查询用户信息 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

用户组织管理

版本说明

根据用户id，或外部用户id，或手机号，或账号获取用户详情

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据组织id，或外部组织id获取组织详情

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取组织顶级节点

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据父级id，或外部父级id获取下级组织分页列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据组织id分页获取人员信息

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取组织的单位信息

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据角色查询用户详情列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

组织信息搜索

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据人员id列表获取人员基本信息列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据用户id获取用户信息

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取用户所在的组织信息

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

通过组织id列表获取组织

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据用户扩展属性查询用户信息

请求参数

请求示例

返回参数

成功返回示例

失败返回示例