Appearance
角色权限管理
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
获取指定用户角色信息
| 接口名称 | 根据appKey获取指定用户角色信息 |
|---|---|
| 接口描述 | 根据appKey获取指定用户角色信息 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaListUserRoleInfoWithAppKeyTest |
| 生产API名称 | uaaListUserRoleInfoWithAppKey |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| userId | 用户id | String | 是 |
请求示例
java
String contentJson = "{\"userId\":\"\"}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaListUserRoleInfoWithAppKeyTest";
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 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| roles | 角色信息集合 | List<Object> | 是 |
| roles | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色Id | String | 是 | |
| roleCode | 角色编码 | String | 是 | |
| roleName | 角色名称 | String | 是 | |
| remark | 描述 | String | 是 | |
| enable | 是否启用 | Boolean | 是 | |
| appId | 应用id | String | 是 |
成功返回示例
json
{
"code": "0",
"data": {
"roles":[
{
"roleId":"",
"roleCode":"",
"roleName":"",
"remark":"",
"enable": true,
"appId":""
},
{
"roleId":"",
"roleCode":"",
"roleName":"",
"remark":"",
"enable": true,
"appId":""
}
]
},
"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名称 | uaaAddPermissionTest |
| 生产API名称 | uaaAddPermission |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionCode | 权限编码 | String | 是 | |
| userId | 操作用户id | String | 是 | |
| permissionName | 权限名称 | String | 是 | |
| parentId | 父级id | String | 否 | 不填,默认顶级节点 |
| remark | 描述 | String | 否 | |
| permissionType | 权限资源类型 | String | 是 | 1:menu;2:button;3:api;4:data;5:other |
| enable | 是否启用 | Boolean | 是 | |
| orderNum | 序号 | Integer | 否 |
请求示例
java
String contentJson = "{\"permissionCode\":\"\",\"userId\":\"\",\"permissionName\":\"\",\"parentId\":\"\",\"remark\":\"\",\"permissionType\":\"\",\"enable\": true,\"orderNum\": 0}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaAddPermissionTest";
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 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionId | 权限id | String | 是 |
成功返回示例
json
{
"code": "0",
"data": {
"permissionId":""
},
"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名称 | uaaModifyPermissionTest |
| 生产API名称 | uaaModifyPermission |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionId | 权限id | String | 是 | |
| permissionCode | 权限编码 | String | 是 | |
| userId | 操作用户id | String | 是 | |
| permissionName | 权限名称 | String | 是 | |
| parentId | 父级id | String | 否 | 不填,默认顶级节点 |
| remark | 描述 | String | 否 | |
| permissionType | 权限资源类型 | String | 是 | 1:menu;2:button;3:api;4:data;5:other |
| enable | 是否启用 | Boolean | 是 | |
| orderNum | 序号 | Integer | 否 |
请求示例
java
String contentJson = "{\"permissionId\":\"\",\"permissionCode\":\"\",\"userId\":\"\",\"permissionName\":\"\",\"parentId\":\"\",\"remark\":\"\",\"permissionType\":\"\",\"enable\": true,\"orderNum\": 0}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaModifyPermissionTest";
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 | 否 | 无 |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaDeletePermissionTest |
| 生产API名称 | uaaDeletePermission |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionId | 权限id | String | 是 | |
| userId | 操作用户id | String | 是 |
请求示例
java
String contentJson = "{\"permissionId\":\"\",\"userId\":\"\"}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaDeletePermissionTest";
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 | 否 | 无 |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaGetPermissionByRoleCodeTest |
| 生产API名称 | uaaGetPermissionByRoleCode |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleCode | 角色码 | String | 是 |
请求示例
java
String contentJson = "{\"roleCode\":\"\"}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaGetCurrentAppPermissionByRoleCodeTest";
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 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissions | 权限资源集合 | List<Object> | 是 |
| permissions | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionId | 权限资源id | String | 是 | |
| permissionName | 权限资源名称 | String | 是 | |
| parentId | 父级权限id | String | 是 | |
| permissionType | 权限资源类型 | Integer | 是 | |
| permissionCode | 权限编码 | String | 是 | |
| remark | 备注 | String | 否 |
成功返回示例
json
{
"code": "0",
"data": {
"permissions":[
{
"permissionId":"",
"permissionName":"",
"parentId":"",
"permissionType":"",
"permissionCode":"",
"remark":""
}
]
},
"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名称 | uaaGetPermissionsTest |
| 生产API名称 | uaaGetPermissions |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| parentId | 父级资源id | String | 否 | 会返回父级下所有子层级数据 |
| permissionType | 资源类型 | Integer | 否 | 1:menu;2:button;3:api;4:data;5:other |
| permissionName | 资源权限名称 | String | 否 | |
| permissionCode | 资源权限编码 | String | 否 | |
| enable | 是否启用 | Boolean | 否 | true表示查询启用的数据;<br/>false表示查询禁用的数据 |
请求示例
java
String contentJson = "{\"parentId\":\"\",\"permissionType\": 1, \"permissionName\":\"\", \"permissionCode\":\"\", \"enable\":true}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaGetPermissionsTest";
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 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissions | 权限资源集合 | List<Object> | 是 |
| permissions | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| permissionId | 权限资源id | String | 是 | |
| permissionName | 权限资源名称 | String | 是 | |
| parentId | 父级权限id | String | 是 | |
| permissionType | 权限资源类型 | Integer | 是 | |
| permissionCode | 权限编码 | String | 是 | |
| remark | 备注 | String | 否 | |
| children | 子级资源权限集合 | Array | 否 | 数据结构和父级的一样 |
成功返回示例
json
{
"code": "0",
"data": {
"permissions":[
{
"permissionId":"",
"permissionName":"",
"parentId":"",
"permissionType":"",
"permissionCode":"",
"remark":"",
"children":[]
}
]
},
"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名称 | uaaAddRoleTest |
| 生产API名称 | uaaAddRole |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleList | 角色集合 | List<Object> | 否 | |
| roleName | 角色名称 | String | 是 | |
| roleCode | 角色编码 | String | 是 | |
| remark | 备注 | String | 否 | |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleList\":[{\"roleName\":\"\",\"roleCode\":\"\",\"remark\":\"\"}]}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaAddRoleTest";
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 | 返回内容 | Boolean | 否 |
成功返回示例
json
{
"code": "0",
"data": 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
}修改角色
| 接口名称 | 修改角色 |
|---|---|
| 接口描述 | 修改角色 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaModifyRoleTest |
| 生产API名称 | uaaModifyRole |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 是 | |
| roleName | 角色名称 | String | 是 | |
| roleCode | 角色编码 | String | 是 | |
| remark | 备注 | String | 否 | |
| enable | 是否启用 | Boolean | 是 | |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleId\":\"\",\"roleName\":\"\",\"roleCode\":\"\",\"remark\":\"\",\"enable\":\"\"}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaModifyRoleTest";
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 | 返回内容 | Boolean | 否 |
成功返回示例
json
{
"code": "0",
"data": 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
}删除角色
| 接口名称 | 删除角色 |
|---|---|
| 接口描述 | 删除角色 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaDeleteRoleTest |
| 生产API名称 | uaaDeleteRole |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 是 | |
| operator | 操作用户Id | String | 是 |
请求示
java
String contentJson = "{\"operator\":\"\",\"roleId\":\"\"}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaDeleteRoleTest";
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 | 返回内容 | Boolean | 否 |
成功返回示例
json
{
"code": "0",
"data": 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
}查询应用下的角色
| 接口名称 | 查询应用下的角色 |
|---|---|
| 接口描述 | 查询应用下的角色 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaListAppRolesTest |
| 生产API名称 | uaaListAppRoles |
| 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 = "uaaGetRoleByAppIdTest";
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 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| roles | 角色集合 | List<Object> | 是 |
| roles | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 是 | |
| roleCode | 角色编码 | String | 是 | |
| roleName | 角色名称 | String | 是 | |
| remark | 备注 | String | 是 | |
| enable | 是否启用 | Boolean | 是 | |
| appId | 应用id | String | 是 |
成功返回示例
json
{
"code": "0",
"data": {
"roles":[
{
"roleId":"",
"roleCode":"",
"roleName":"",
"remark":"",
"enable": true,
"appId":""
}
]
},
"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名称 | uaaRoleBindPermissionTest |
| 生产API名称 | uaaRoleBindPermission |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色Id | String | 是 | |
| permissionIds | 权限资源id集合 | List<String> | 是 | 一次最多只能传100个 |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleId\":\"\",\"permissionIds\": []}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaRoleBindPermissionTest";
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 | 否 | null |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaRoleUnBindPermissionTest |
| 生产API名称 | uaaRoleUnBindPermission |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色Id | String | 是 | |
| permissionIds | 权限资源id集合 | List<String> | 是 | 一次最多只能传100个 |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleId\":\"\",\"permissionIds\": []}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaRoleUnBindPermissionTest";
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 | 否 | null |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaUserIdBindRolesTest |
| 生产API名称 | uaaUserIdBindRoles |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| userId | 用户Id | String | 是 | |
| roleIds | 角色id集合 | List<String> | 是 | 一次最多只能传100个 |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"userId\":\"\",\"roleIds\": []}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaUserIdBindRolesTest";
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 | 否 | null |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaUserIdUnBindRolesTest |
| 生产API名称 | uaaUserIdUnBindRoles |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| userId | 用户Id | String | 是 | |
| roleIds | 角色id集合 | List<String> | 是 | 一次最多只能传100个 |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"userId\":\"\",\"roleIds\": []}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaUserIdUnBindRolesTest";
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 | 否 | null |
成功返回示例
json
{
"code": "0",
"data": null,
"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名称 | uaaOrgRoleAddTest |
| 生产API名称 | uaaOrgRoleAdd |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 否 | |
| roleCode | 角色code | String | 否 | roleId/roleCode 必填一个 |
| orgId | 组织id | String | 是 | |
| authSub | 是否绑定组织的下属机构 true-下属机构一并绑定 | Boolean | 否 | |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleCode\":\"ORG_EDIT\",\"roleId\": \"01\",\"orgId\": \"01\",\"authSub\": false}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaOrgRoleAddTest";
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 | 返回内容 | Boolean | 否 |
成功返回示例
json
{
"code": "0",
"data": 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
}组织解绑角色
| 接口名称 | 组织解绑角色 |
|---|---|
| 接口描述 | 组织解绑角色 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaOrgRoleDeleteTest |
| 生产API名称 | uaaOrgRoleDelete |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 否 | |
| roleCode | 角色code | String | 否 | roleId/roleCode 必填一个 |
| orgId | 组织id | String | 是 | |
| authSub | 是否解绑组织的下属机构 true-下属机构一并解绑 | Boolean | 否 | |
| operator | 操作用户Id | String | 是 |
请求示例
java
String contentJson = "{\"operator\":\"\",\"roleCode\":\"ORG_EDIT\",\"roleId\": \"01\",\"orgId\": \"01\",\"authSub\": false}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaOrgRoleDeleteTest";
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 | 返回内容 | Boolean | 否 |
成功返回示例
json
{
"code": "0",
"data": 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分页查询组织信息 |
| 接口地址 | https://api-one.digitalhainan.com.cn/apione |
| 测试API名称 | uaaPageOrgInfoListByRoleIdTest |
| 生产API名称 | uaaPageOrgInfoListByRoleId |
| API版本 | |
| 调用方式 | |
| http方法 | POST |
| 是否需要鉴权 | 是,授权账号参照账号信息文件 |
| 提供方 | 统一认证系统 |
| 目前在用渠道 | |
| 废弃日期 |
请求参数
| Header | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| Uaa-App-Key | 统一认证应用的ak | String | 是 | |
| Uaa-Tenant-Id | 租户id | String | 是 | 默认:1 |
| 字段名称 | 字段说明 | 字段类型 | 必填 | 备注 |
|---|---|---|---|---|
| roleId | 角色id | String | 是 | |
| pageNum | 第几页 | Int | 是 | |
| pageSize | 一页返回多少条记录 | Int | 是 | 最大值100 |
请求示例
java
String contentJson = "{\"roleId\":\"122991921\",\"pageNum\": 1, \"\pageSize": 10}";
String ak = ""; //开放平台发放的accessKey
String sk = ""; //开放平台发放的secretKey
String api = "uaaPageOrgInfoListByRoleIdTest";
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 | 返回内容 | Boolean | 否 |
| data字段 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| pageNum | 第几页 | Int | 否 | |
| pageSize | 一页返回多少条记录 | Int | 否 | |
| pages | 总页数 | Int | 否 | |
| total | 总记录数 | Int | 否 | |
| records | 记录数据 | List | 否 |
| records字段 | 字段说明 | 类型 | 必填 | 备注 |
|---|---|---|---|---|
| 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 | 否 | |
| address | 地址 | String | 否 | |
| contacts | 联系人 | String | 否 | |
| contactTel | 联系电话 | String | 否 | |
| contactTelAreaCode | 联系电话区号 | String | 否 | 可通过字典接口,dictType=phone_area_code的方式获取 |
| unitName | 单位全称 | String | 否 | org_type为:单位 或者 是临时组织的,都属于必填项 |
| belongLine | 所属条线 | String | 否 | 可通过字典接口,dictType=belong_line的方式获取;针对org_type为:单位、临时组织、条线虚节点,属于必填项 |
| departmentLevel | 部门级别 | String | 否 | 可通过字典接口,dictType=department_level的方式获取;针对org_type:单位,属于必填项 |
| zipCode | 邮政编码 | String | 否 |
成功返回示例
json
{
"code": "0",
"data": {
"pageNum": 1,
"pageSize": 10,
"total": 1,
"pages":1,
"records": [
{
"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": null
}