登录认证管理

版本说明

版本	更新时间	更新负责人	更新内容
v1.0		彭业庆
v1.1	2022-02-17	彭业庆	1、更换新的接口地址：https://api-one.digitalhainan.com.cn/apione<br/>2、请求头带上必填项：Uaa-Tenant-Id<br/>3、region = “PUBLIC” 改成 region = “INTER”
v1.2	2022-02-20	彭业庆	1、新增接口：<br/>修改当前用户密码；<br/>首次登录修改初始密码和补录手机号<br/>2、登录接口新增返回字段<br/>
v1.3	2022-03-28	彭业庆	1、人员所属组织列表接口新增返回字段，所属单位id：unitId；<br/>2、废弃“获取用户所属组织下人员分页列表”接口<br/>3、废弃“获取指定机构下的人员列表”接口
v1.4	2022-06-16	彭业庆	1、“人员所属组织列表接口”和“根据父级机构获取下级机构列表接口”新增返回字段，行政区划编码：areaCode；行政区划名称：areaName；统一信用代码：unifiedSocialCreditCode；<br/>

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

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

字段名称	字段说明	类型	必填	备注
appKey	appKey	String	是	统一认证发放的appKey
appSecret	appSecret	String	是	统一认证发放的appSecret
account	账号	String	是
password	密码	String	是

String contentJson = "{\"appKey\":\"\",\"appSecret\":\"\",\"account\":\"\",\"password\":\"\"}";
String ak = "";  //开放平台发放的accessKey
String sk = "";	 //开放平台发放的secretKey
String api = "uaaLoginTest";
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-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	字段说明	类型	必填	备注
token	主token	String	是
refreshToken	刷新token	String	否	默认不返回
expiredIn	主token过期时间单位秒	Number	是
addPhone	是否需要补录手机号	Boolean	是
resetPassword	是否需要重置密码	Boolean	是
userId	用户id	String	是
username	账号	String	是
displayName	昵称	String	是

成功返回示例

json

{
    "requestId": "15902051813530044359",
    "success": true,
    "code": null,
    "message": null,
    "data": {
        "token": "xxx",
        "refreshToken": "xxx",
        "expiredIn": 604800,
      	"username": "xx",
    		"displayName": "xx",
      	"userId": "xx",
    		"addPhone": false,
    		"resetPassword": true
    },
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_USER_ACCT_PWD_WRONG",
    "message": "账号或者密码错误",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

token获取用户详情

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

请求参数

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

请求示例

java

String contentJson = "";
String ak = "";  // 开放平台发放的accessKey
String sk = "";  // 开放平台发放的secretKey
String api = "uaaUserDetailByTokenTest";
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 xxx");  // xxx需要替换成统一认证平台的token
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	字段说明	类型	必填	备注
userId	用户id	String	是
account	账户	String	是
nickName	显示名称	String	是
phone	手机号	String	否
email	邮箱	String	否
externalId	外部系统用户id	String	否
enable	是否启用	Boolean	是
createTime	创建时间	String	是	格式：2020-01-02 11:00:00
extendMap	扩展属性	String	否	例如：{“gender”:“男”,“age”:“13”}

成功返回示例

json

{
    "requestId": "15902051813530044359",
    "success": true,
    "code": null,
    "message": null,
    "data": {
        "userId": "1111",
        "account": "xx",
        "nickName": "xxx",
        "phone": "13455",
        "email": "222",
        "externalId": "xdsdd",
      	"enable":true,
      	"createTime":"2020-01-02 11:00:00",
        "extendMap":"{\"gender\":\"男\",\"age\":\"13\"}"
    },
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

根据授权码换取token

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

请求参数

Header	字段说明	类型	必填	备注
Uaa-Tenant-Id	租户id	String	是	默认：1

Body	字段说明	类型	必填
appKey	应用key	String	是
appSecret	应用secret	String	是
code	授权码	String	是
redirectUri	重定向地址	String	是

请求示例

json

String contentJson = "{\"appKey\":\"\",\"appSecret\":\"\",\"code\":\"\",\"redirectUri\":""}";
String ak = "";
String sk = "";
String api = "uaaOauthTokenTest";
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-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	字段说明	类型	必填
accessToken	主token	String	是
expiredIn	主token过期时间，单位秒	Number	是
refreshToken	刷新token	String	是

成功返回示例

json

{
    "requestId": "15902051813530044359",
    "success": true,
    "code": null,
    "message": null,
    "data": {
          	"accessToken": "xxx",
            "expiredIn": 604800,
            "refreshToken": "xxx"
          },
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

获取用户已授权应用列表

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

请求参数

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

请求示例

java

String contentJson = "入参的请求参数";
String ak = "";
String sk = "";
String api = "uaaGetUserAuthAppsTest";
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 xxx");
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	返回内容	Array	否

data	字段说明	类型	必填
appId	应用id	String	是
appName	应用名称	String	是
enable	是否启用	Boolean	是
remark	描述	String	否

成功返回示例

json

{
	"code": "",
	"data": {
		"apps": [
			{
				"appId": "",
				"appName": "",
				"enable": true,
				"remark": ""
			}
		]
	},
	"debugMessage": "",
	"debugTrace": "",
	"extend": {},
	"message": "",
	"requestId": "",
	"success": true
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

获取用户所属组织列表

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

请求参数

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

Body	字段说明	类型	必填	备注
positionType	任职类型	String	否	任职类型，默认是主职；ALL - 所有；MAIN - 主职；ADJUNCT - 非主职

请求示例

json

String contentJson = "";
String ak = "";
String sk = "";
String api = "uaaGetUserOrgsTest";
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 xxx");
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	返回内容	Object	否

data	字段说明	类型	必填
orgs	组织列表	Array	否
orgId	组织id	String	否
orgName	组织名称	String	否
parentOrgId	父级id	String	否
externalId	外部id	String	否
fullNamePath	组织名称路径	String	否
leaf	是否叶子节点	Boolean	否
enable	是否启用	Boolean	否
remark	描述	String	否
sortNum	序号	Number	否
parentIdPath	父级id路径	String	否
unitId	所属单位id	String	否
areaCode	行政区划编码	String	否
areaName	行政区划名称	String	否
unifiedSocialCreditCode	统一信用代码	String	否
mainJob	是否主职	Boolean	否

成功返回示例

json

{
    "requestId": "15902051813530044359",
    "success": true,
    "code": null,
    "message": null,
    "data": {
      	"orgs": [
          {
          	"orgId": "1111",
            "orgName": "测试111",
            "parentOrgId": "333",
            "fullNamePath": "/测试1/测试11/测试111",
            "leaf": true,
            "enable": true,
            "remark": "",
						"sortNum": 0,
            "externalId": "",
            "parentIdPath": "",
            "unitId": "",
            "areaCode": "",
            "areaName": "",
            "unifiedSocialCreditCode": "",
            "mainJob": true
          }
        ]
    },
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

获取用户已拥有角色列表

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

请求参数

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

Body	字段说明	类型	必填	备注
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是	最大值100

请求示例

json

String contentJson = "";
String ak = "";
String sk = "";
String api = "uaaGetUserRolesTest";
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 xxx");
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	返回内容	Object	否

data	字段说明	类型	必填
records	角色信息	Array	否
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是
pages	总页数	Number	是
total	总记录数	Number	是

records	字段说明	类型	必填
roleId	角色id	String	否
roleCode	角色编码	String	否
roleName	角色名称	String	否
enable	是否启用	Boolean	否
remark	描述	String	否

成功返回示例

json

{
    "success":true,
    "code":"0",
    "message":null,
    "data":{
        "pageNum":1,
        "pageSize":10,
        "pages":1,
        "total":1,
        "records":[
            {
                "roleId":"1234567",
                "roleCode":"role",
                "roleName":"超级管理员",
                "remark":"超级管理员",
                "enable":true
            }
        ]
    },
    "extend":null,
    "debugMessage":"",
    "debugTrace":null,
    "requestId":"0723ae5264fa46178397909ef8250cde"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

获取用户已拥有权限资源列表

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

请求参数

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

Body	字段说明	类型	必填	备注
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是	最大值100

请求示例

json

String contentJson = "";
String ak = "";
String sk = "";
String api = "uaaGetUserPermissionsTest";
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 xxx");
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	返回内容	Object	否

data	字段说明	类型	必填
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是
total	总条数	Number	是
records	用户信息列表	Array	否

records	字段说明	类型	必填	备注
permissionId	权限资源id	String	否
permissionCode	权限资源编码	String	否
permissionName	权限资源名称	String	否
parentId	父级id	String	否
permissionType	权限资源类型	Number	否	1：menu；2：button；3：api；4：data；5：other

成功返回示例

json

{
	"code": "",
	"data": {
		"pageNum": 0,
		"pageSize": 0,
		"pages": 0,
		"records": [
			{
				"parentId": "",
				"permissionCode": "",
				"permissionId": "",
				"permissionName": "",
				"permissionType": 0,
				"remark": ""
			}
		],
		"total": 0
	},
	"debugMessage": "",
	"debugTrace": "",
	"extend": {},
	"message": "",
	"requestId": "",
	"success": true
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

退出

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

请求参数

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

Body	字段说明	类型	必填	备注

请求示例

json

String contentJson = "";
String ak = "";
String sk = "";
String api = "uaaLogoutTest";
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	返回内容	Object	否

成功返回示例

json

{
    "requestId": "15902051813530044359",
    "success": true,
    "code": null,
    "message": null,
    "data": null,
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

获取当前应用下已授权人员分页列表

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

请求参数

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

Body	字段说明	类型	必填	备注
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是	最大值100
nickName	姓名	String	否
account	账号	String	否
phone	手机号	String	否
enable	是否启用	Boolean	否

请求示例

json

String contentJson = "{\"pageSize\":10,\"pageNum\":1}";
String ak = "";
String sk = "";
String api = "uaaGetAuthAppUserPageTest";
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	返回内容	Object	否

data	字段说明	类型	必填
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是
total	总条数	Number	是
pages	总页数	Number	是
records	用户信息列表	Array	否

records	字段说明	类型	必填	备注
userId	用户id	String	是
account	账户	String	是
nickName	显示名称	String	是
phone	手机号	String	否
email	邮箱	String	否
externalId	外部系统用户id	String	否
enable	是否启用	Boolean	是
createTime	创建时间	String	是	yyyy-MM-dd HH:mm:ss

成功返回示例

json

{
    "success":true,
    "code":"0",
    "message":null,
    "data":{
        "pageNum":1,
        "pageSize":10,
        "pages":1,
        "total":2,
        "records":[
            {
                "userId":"xxxx",
                "account":"1234567",
                "nickName":"**",
                "phone":"xx",
                "email":null,
                "externalId":"xxx",
                "enable":true,
                "createTime":"2021-12-09 15:35:31"
            },
            {
                "userId":"xx",
                "account":"123456",
                "nickName":"吴xxx",
                "phone":"xx",
                "email":null,
                "externalId":"xx",
                "enable":true,
                "createTime":"2021-12-09 15:35:31"
            }
        ]
    },
    "extend":null,
    "debugMessage":"",
    "debugTrace":null,
    "requestId":"0c8bf2283b884a75867623a9bbaa1799"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

刷新token

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

请求参数

Header	字段说明	类型	必填	备注
Uaa-Tenant-Id	租户id	String	是	默认：1

Body	字段说明	类型	必填
appKey	应用key	String	是
appSecret	应用密钥	String	是
refreshToken	刷新token	String	是

请求示例

json

String contentJson = "{\"appKey\":\"\",\"appSecret\":\"\",\"refreshToken\":\"\"}";
String ak = "";
String sk = "";
String api = "uaaRefreshTokenTest";
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-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	字段说明	类型	必填
accessToken	新token	String	是
refreshToken	刷新token	String	是
expiredIn	token过期时间，单位秒	Number	是

成功返回示例

json

{
    "success":true,
    "code":"0",
    "message":null,
    "data":{
        "accessToken":"xxx",
        "refreshToken":"xxxx",
        "expiredIn":1
    },
    "extend":null,
    "debugMessage":"",
    "debugTrace":null,
    "requestId":"0c8bf2283b884a75867623a9bbaa1799"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

全局精准用户分页查询

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

请求参数

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

Body	字段说明	类型	必填	备注
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是	最大值100
nickName	姓名	String	否
account	账号	String	否
phone	手机号	String	否

请求示例

json

String contentJson = "{\"pageSize\":10,\"pageNum\":1}";
String ak = "";
String sk = "";
String api = "uaaAccurateSearchUserPageTest";
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	返回内容	Object	否

data	字段说明	类型	必填
pageNum	第几页	Number	是
pageSize	一页返回多少条记录	Number	是
total	总条数	Number	是
pages	总页数	Number	是
records	用户信息列表	Array	否

records	字段说明	类型	必填	备注
userId	用户id	String	是
account	账户	String	是
nickName	显示名称	String	是
phone	手机号	String	是	脱敏返回

成功返回示例

json

{
  "success": true,
  "code": "0",
  "message": null,
  "data": {
    "pageNum": 1,
    "pageSize": 10,
    "pages": 1,
    "total": 1,
    "records": [
      {
        "account": "xx",
        "phone": "1355676",
        "nickName": "xx",
        "userId": "xxx"
      }
    ]
  },
  "extend": null,
  "debugMessage": "",
  "debugTrace": null,
  "requestId": "ef79706e7b7a4ce3ac3e1ce0e171963f"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

修改当前用户密码

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

请求参数

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

Body	字段说明	类型	必填
oldPassword	原密码	String	是
newPassword	新密码	String	是
confirmPassword	确认密码	String	是

请求示例

json

String content = "{\"oldPassword\":\"\",\"newPassword\":\"\",\"confirmPassword\":\"\"}";
String ak = "";
String sk = "";
String api = "uaaUpdateCurrentUserPasswordTest";
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	返回内容	Object	否

成功返回示例

json

{
    "success":true,
    "code":"0",
    "message":null,
    "data":true,
    "extend":null,
    "debugMessage":"",
    "debugTrace":null,
    "requestId":"c50f0e21405c4e3e993e49dd1196e0a1"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

根据AK、SK获取应用ticket

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

请求参数

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

Body	字段说明	类型	必填	备注
appKey	应用ak	String	是
secretKey	应用sk	String	是

请求示例

json

String content = "{\"appKey\":\"\",\"secretKey\":\"\"}";
String ak = "";
String sk = "";
String api = "getAppTicket";
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	返回内容	Object	否

data	字段说明	类型	必填	备注
ticket	凭证	String	是
expiresIn	凭证时长	Int	是	单位秒
appKey	应用ak	String	是

成功返回示例

json

{
    "success":true,
    "code":"0",
    "message":null,
    "data": {
      "ticket": "",
      "expiresIn": 7200,
      "appKey":""
    },
    "extend":null,
    "debugMessage":"",
    "debugTrace":null,
    "requestId":"c50f0e21405c4e3e993e49dd1196e0a1"
}

失败返回示例

json

{
    "requestId": "15902051813530044359",
    "success": false,
    "code": "ERR_RETRY",
    "message": "请稍后重试",
  	"debugMessage": "",
		"debugTrace": "",
		"extend": {}
}

登录认证管理 ​

版本说明 ​

登录 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

token获取用户详情 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据授权码换取token ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取用户已授权应用列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取用户所属组织列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取用户已拥有角色列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取用户已拥有权限资源列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

退出 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

获取当前应用下已授权人员分页列表 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

刷新token ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

全局精准用户分页查询 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

修改当前用户密码 ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

根据AK、SK获取应用ticket ​

请求参数 ​

请求示例 ​

返回参数 ​

成功返回示例 ​

失败返回示例 ​

登录认证管理

版本说明

登录

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

token获取用户详情

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据授权码换取token

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取用户已授权应用列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取用户所属组织列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取用户已拥有角色列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取用户已拥有权限资源列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

退出

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

获取当前应用下已授权人员分页列表

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

刷新token

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

全局精准用户分页查询

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

修改当前用户密码

请求参数

请求示例

返回参数

成功返回示例

失败返回示例

根据AK、SK获取应用ticket

请求参数

请求示例

返回参数

成功返回示例

失败返回示例