Skip to content

角色权限管理

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
userId用户idString

请求示例

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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Object
data字段说明类型必填备注
roles角色信息集合List<Object>
roles字段说明类型必填备注
roleId角色IdString
roleCode角色编码String
roleName角色名称String
remark描述String
enable是否启用Boolean
appId应用idString

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
permissionCode权限编码String
userId操作用户idString
permissionName权限名称String
parentId父级idString不填,默认顶级节点
remark描述String
permissionType权限资源类型String1: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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Object
data字段说明类型必填备注
permissionId权限idString

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
permissionId权限idString
permissionCode权限编码String
userId操作用户idString
permissionName权限名称String
parentId父级idString不填,默认顶级节点
remark描述String
permissionType权限资源类型String1: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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
permissionId权限idString
userId操作用户idString

请求示例

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认: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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Object
data字段说明类型必填备注
permissions权限资源集合List<Object>
permissions字段说明类型必填备注
permissionId权限资源idString
permissionName权限资源名称String
parentId父级权限idString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
parentId父级资源idString会返回父级下所有子层级数据
permissionType资源类型Integer1:menu;2:button;3:api;4:data;5:other
permissionName资源权限名称String
permissionCode资源权限编码String
enable是否启用Booleantrue表示查询启用的数据;<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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Object
data字段说明类型必填备注
permissions权限资源集合List<Object>
permissions字段说明类型必填备注
permissionId权限资源idString
permissionName权限资源名称String
parentId父级权限idString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleList角色集合List<Object>
roleName角色名称String
roleCode角色编码String
remark备注String
operator操作用户IdString

请求示例

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色idString
roleName角色名称String
roleCode角色编码String
remark备注String
enable是否启用Boolean
operator操作用户IdString

请求示例

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色idString
operator操作用户IdString

请求示

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认: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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Object
data字段说明类型必填备注
roles角色集合List<Object>
roles字段说明类型必填备注
roleId角色idString
roleCode角色编码String
roleName角色名称String
remark备注String
enable是否启用Boolean
appId应用idString

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色IdString
permissionIds权限资源id集合List<String>一次最多只能传100个
operator操作用户IdString

请求示例

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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Objectnull

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色IdString
permissionIds权限资源id集合List<String>一次最多只能传100个
operator操作用户IdString

请求示例

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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Objectnull

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
userId用户IdString
roleIds角色id集合List<String>一次最多只能传100个
operator操作用户IdString

请求示例

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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Objectnull

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
userId用户IdString
roleIds角色id集合List<String>一次最多只能传100个
operator操作用户IdString

请求示例

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请求IdString
success状态码Boolean状态码: true表示成功  false表示失败
code错误码String
message响应消息String
extend扩展响应内容Object
debugMessage异常信息String测试环境才返回,方便接口调试错误排查
debugTrace异常堆栈信息String测试环境才返回,方便接口调试错误排查
data返回内容Objectnull

成功返回示例

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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色idString
roleCode角色codeStringroleId/roleCode 必填一个
orgId组织idString
authSub是否绑定组织的下属机构 true-下属机构一并绑定Boolean
operator操作用户IdString

请求示例

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色idString
roleCode角色codeStringroleId/roleCode 必填一个
orgId组织idString
authSub是否解绑组织的下属机构 true-下属机构一并解绑Boolean
operator操作用户IdString

请求示例

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请求IdString
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统一认证应用的akString
Uaa-Tenant-Id租户idString默认:1
字段名称字段说明字段类型必填备注
roleId角色idString
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请求IdString
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组织idString
orgName组织名称String
externalId组织外部idString
parentOrgId组织父级idString
sortNum排序号Int
leaf是否叶子节点Boolean
extendMap扩展属性Stringjson字符串
orgType组织类型String组织类型;GOV_HOLLOW_STRIP_NODE:条线虚节点;GOV_UNIT:单位;GOV_HOLLOW_DIVISION_NODE:行政区划虚节点;GOV_INTERNAL_INSTITUTION:内设机构;GOV_VIRTUAL:虚拟组织
enable是否启用Boolean
unitId单位idString
createTime创建时间Stringyyyy-MM-dd HH:mm:ss
updateTime更新时间Stringyyyy-MM-dd HH:mm:ss
areaCode行政区划编码String
areaName行政区划名称String
unifiedSocialCreditCode统一信用代码String
address地址String
contacts联系人String
contactTel联系电话String
contactTelAreaCode联系电话区号String可通过字典接口,dictType=phone_area_code的方式获取
unitName单位全称Stringorg_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
}