https://cic_irc.yuque.com/tyl581/ggwv9w/sgsxbauvfus98u7r
maven依赖/版本记录
此处为语雀内容卡片,点击链接查看:https://cic_irc.yuque.com/tyl581/ggwv9w/kmod3po8yw8pg54k
1. 通过资源标识获取功能配置(权限码)信息
1.1. 接口功能
通过资源标识,查询功能配置信息
1.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | FunctionRpcFacade |
| 函数名 | getFunctionInfoByResourceFlag |
1.3. 请求参数
| 参数 | 类型 | 是否必填 | 描述 |
| resourceFlag | String | 是 | 资源标识 |
1.4. 响应格式
FunctionResDTO:
| 参数 | 类型 | 描述 |
| functionCode | String | 功能配置编码(权限码) |
| functionType | String | 功能类型(1:领域;2:页面;3:按钮;4:API) |
| functionName | String | 资源名称 |
2. 根据角色编码查询角色基础信息
2.1. 接口功能
根据角色编码获取到角色基础信息,包含id,角色名称,描述,所属应用等
2.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | RoleRpcFacade |
| 函数名 | getRoleInfoByRoleCode |
2.3. 请求参数
| 参数 | 类型 | 是否必填 | 描述 |
| roleCode | String | 是 | 角色编码 |
{
"roleCode": "RO_OSD_ExternalAccount"
}
2.4. 响应格式
| RoleResDTO参数 | 类型 | 描述 |
| roleId | String | 角色Id |
| roleName | String | 角色名称 |
| roleCode | String | 角色编码 |
| appId | String | 应用ID |
| roleDesc | String | 角色描述 |
| functionCodeList | List | 权限码列表 |
示例:
{
"status": 1,
"message": null,
"data": {
"roleId": "6919907273870131201",
"roleName": "出单岗",
"roleCode": "DZ1000005000",
"appId": "M010007",
"roleDesc": "出单岗描述信息",
"functionCodeList" :[
"PP_OSD_BasicData_Organization_Export&Result",
"PP_OSD_BasicData_Organization_Export"
]
}
}
3. 通过账号ID和权限码获取角色授权数据
3.1. 接口功能
通过账户ID、权限码等信息,查询角色授权列表(包含机构数据权限)
3.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getAccountPermissionByAccIdAndPermissionCode |
3.3. 请求参数
| AccountPermissionReqDTO参数 | 类型 | 是否必填 | 描述 |
| accId | String | 是 | 账号ID |
| permissionCode | String | 是 | 权限码 |
{
"permissionCode":"RO_RPM_Config",
"accId":"1010000931"
}
3.4. 响应格式
List
| 参数 | 类型 | 描述 |
| roleId | String | 角色ID |
| roleCode | String | 角色编码 |
| appId | String | 应用ID |
| orgPermissionDTOList | List | 机构权限列表 |
OrgPermissionDTO:
| 参数 | 类型 | 描述 |
| orgPermissionCode | String | 机构权限编码 |
| includeChild | boolean | 是否包含下级 |
{
"status": 1,
"message": null,
"data": [
{
"roleId": "6919907273870131201",
"roleCode": "RO_RPM_Config",
"appId": "P010019",
"orgPermissionDTOList": [
{
"orgPermissionCode" : "211100000000",
"includeChild": true
},
{
"orgPermissionCode" : "211300000000",
"includeChild":false
},
]
}
]
}
4. 通过账户ID获取被授权(可使用)角色列表
4.1. 接口功能
通过账户ID获取被授权(可使用)角色列表(包含机构数据权限)
4.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getRolePermissionByAccId |
4.3. 请求参数
| 参数 | 类型 | 是否必填 | 描述 |
| accId | String | 是 | 账户ID |
{
accId : "1010000931"
}
4.4. 响应格式
List
| 参数 | 类型 | 描述 |
| roleId | String | 角色ID |
| roleCode | String | 角色编码 |
| roleName | String | 角色名称 |
| appId | String | 应用ID |
| functionCodeList | List | 权限码列表 |
| orgPermissionDTOList | List | 机构权限列表 |
OrgPermissionDTO:
| 参数 | 类型 | 描述 |
| orgPermissionCode | String | 机构权限编码 |
| includeChild | boolean | 是否包含下级 |
{
"status": 1,
"message": null,
"data": [
{
"roleId": "6919907273870131201",
"roleName": "出单岗",
"roleCode": "DZ1000005000",
"appId": "M010007",
"orgPermissionDTOList": [
{
"orgPermissionCode" : "211300000000",
"includeChild":false
}
]
"functionCodeList" :[
"PP_OSD_BasicData_Organization_Export&Result",
"PP_OSD_BasicData_Organization_Export"
]
},
{
"roleId": "8919907273870131201",
"roleName": "财务岗",
"roleCode": "DZ2132155333",
"appId": "P010008",
"orgPermissionDTOList": [
{
"orgPermissionCode" : "211100000000",
"includeChild": true
}
]
"functionCodeList" :[
"PP_OSD_BasicData_Organization_Export&Result",
"PP_OSD_BasicData_Organization_Export"
]
}
]
}
5. 根据应用ID、账号ID查询应用管理员列表
5.1. 接口功能
根据应用ID、账号ID查询应用管理员列表,包含账号ID、应用ID和管理类型
5.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | ApplicationManagerRpcFacade |
| 函数名 | getApplicationManagerList |
5.3. 请求参数
注:入参必须至少传一个
| 参数 | 类型 | 是否必填 | 描述 |
| accId | String | 否 | 账号ID |
| appId | String | 否 | 应用ID |
{
"appId":"M010007",
"accId":"1010001553"
}
5.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| appId | String | 应用ID |
| ownerType | String | 管理类型 |
ownerType参数说明:
- appOwner:应用管理员
- appTechOwner:应用技术管理员
- appBusinessOwner:应用业务管理员
{
"status": 1,
"message": null,
"data": [
{
"accId": "1012012121",
"appId":"M010007",
"ownerType": "appOwner"
},
{
"accId": "1012012134",
"appId":"M010007",
"ownerType": "appTechOwner"
}
]
}
6. 通过权限码获取功能配置信息
6.1. 接口功能
通过权限码列表,查询功能配置信息
6.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | FunctionRpcFacade |
| 函数名 | getFunctionInfoByFunctionCodeList |
6.3. 请求参数
注:参数最大不超过100个
| 参数 | 类型 | 是否必填 | 描述 |
| functionCodeList | List | 是 | 权限码列表 |
6.4. 响应格式
List
| 参数 | 类型 | 描述 |
| functionCode | String | 功能配置编码(权限码) |
| functionType | String | 功能类型(1:领域;2:页面;3:按钮;4:API) |
| functionName | String | 功能配置名称 |
| resourceIdentification | String | 资源标识 |
7. 根据角色+归属机构(自动包含本下级)获取被授权的账号列表
注:本接口返回的结果较最新数据有一小时延迟,历史数据无影响
7.1. 接口功能
根据角色列表+归属机构(本下级)获取被授权的账号列表,主动授权、用户组授权和岗位授权对应的人员清单
(机构匹配归属机构包含本下级)
最多返回2000条,先查单独授权够2000直接返回,不够再查用户组授权补充,不够再查岗位授权补充
例:角色a授权账号b(账号b的归属机构杭州分),输入浙江分可查出账号
7.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getRoleMembersByBranchOrgIncludeChild |
7.3. 请求参数
RoleMemberBatchReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| branchOrgCodeList | List | 是 | 机构编码(最多5个) |
| roleCodeList | List | 是 | 角色编码(最多5个) |
{
"branchOrgCodeList":["210000000000"],
"roleCodeList":["RO_RPM_Config"]
}
7.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| accName | String | 账号名称 |
{
"status": 1,
"message": null,
"data": [
{
"accId": "1010000498",
"accName": "杜锐"
},
{
"accId": "1010001553",
"accName": "刘阳"
}
]
}
8. 根据角色+权限机构获取被授权的账号列表
注:本接口返回的结果较最新数据有一小时延迟,历史数据无影响
获得账号id以后,如果还要查询账号对应的用户信息,可以参考这两个链接
https://cic_irc.yuque.com/tyl581/ggwv9w/xhap0wi0mdbab9sa#ZmCxX
https://cic_irc.yuque.com/tyl581/ggwv9w/str64etgg46gh9gl#C9Brr
8.1. 接口功能
根据角色列表+机构获取被授权的账号列表,主动授权、用户组授权和岗位授权对应的人员清单
(机构匹配数据权限同级机构)
例:角色授权浙江分,输入浙江分可查出账号
8.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getAccountListByRoleCodeAndOrgCode |
8.3. 请求参数
RoleMemberReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| branchOrgCode | String | 是 | 机构编码 |
| roleCode | String | 是 | 角色编码 |
{
"branchOrgCode":"210000000000",
"roleCode":"RO_RPM_Config"
}
8.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| accName | String | 账号名称 |
{
"status": 1,
"message": null,
"data": [
{
"accId": "1010000498",
"accName": "杜锐"
},
{
"accId": "1010001553",
"accName": "刘阳"
}
]
}
9. 根据角色+权限机构(自动包含本下级)获取被授权的账号列表
注:本接口返回的结果较最新数据有一小时延迟,历史数据无影响
待下线
9.1. 接口功能
根据角色列表+权限机构(本下级)获取被授权的账号列表,主动授权、用户组授权和岗位授权对应的人员清单
(机构匹配数据权限包含本下级机构)
最多返回2000条,先查单独授权够2000直接返回,不够再查用户组授权补充,不够再查岗位授权补充
例:角色授权浙江分,输入浙江分可查出账号
9.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getAccountListByRoleAndOrgIncludeChild |
9.3. 请求参数
RoleMemberBatchReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| branchOrgCodeList | List | 是 | 机构编码(最多5个) |
| roleCodeList | List | 是 | 角色编码(最多5个) |
{
"branchOrgCodeList":["210000000000"],
"roleCodeList":["RO_RPM_Config"]
}
9.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| accName | String | 账号名称 |
{
"status": 1,
"message": null,
"data": [
{
"accId": "1010000498",
"accName": "杜锐"
},
{
"accId": "1010001553",
"accName": "刘阳"
}
]
}
10. 根据角色+机构获取岗位授权的内部账号列表
获得账号id以后,如果还要查询账号对应的内部用户信息,可以参考这两个链接
https://cic_irc.yuque.com/tyl581/ggwv9w/xhap0wi0mdbab9sa#ZmCxX
https://cic_irc.yuque.com/tyl581/ggwv9w/str64etgg46gh9gl#C9Brr
10.1. 接口功能
根据角色列表+机构获取岗位授权对应的人员清单
(机构匹配数据本下级机构)
例:岗位授权杭州分,输入浙江分可查出账号
10.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getPositionAccountListByRoleCodeAndOrg |
10.3. 请求参数
PostRoleMemberReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| branchOrgCode | String | 是 | 机构编码 |
| roleCode | String | 是 | 角色编码 |
| pageIndex | Integer | 是 | 页码 |
| pageSize | Integer | 是 | 每页条数(最大不能超过100条) |
{
"branchOrgCode":"210000000000",
"roleCode":"RO_RPM_Config",
"pageIndex":1,
"pageSize":10
}
10.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| accName | String | 账号名称 |
{
"status": 1,
"message": null,
"data": [
{
"accId": "1010000498",
"accName": "杜锐"
},
{
"accId": "1010001553",
"accName": "刘阳"
}
],
"totalCount":10,
"pageSize":10,
"pageIndex":1
}
11. 根据角色+机构获取岗位授权的外部账号列表
11.1. 接口功能
根据角色列表+机构获取岗位授权对应的外部人员清单
11.2. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | AccountPermissionRpcFacade |
| 函数名 | getPositionOutAccountListByRoleCodeAndOrg |
11.3. 请求参数
PostRoleMemberReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| branchOrgCode | String | 是 | 机构编码 |
| roleCode | String | 是 | 角色编码 |
| pageIndex | Integer | 是 | 页码 |
| pageSize | Integer | 是 | 每页条数(最大不能超过100条) |
{
"branchOrgCode":"210000000000",
"roleCode":"RO_RPM_Config",
"pageIndex":1,
"pageSize":10
}
11.4. 响应格式
List
| 参数 | 类型 | 描述 |
| accId | String | 账号ID |
| accName | String | 账号名称 |
{
"status": 1,
"message": null,
"data": [
{
"accId": "1010000498",
"accName": "杜锐"
},
{
"accId": "1010001553",
"accName": "刘阳"
}
],
"totalCount":10,
"pageSize":10,
"pageIndex":1
}
12. 授权用户组相关
12.1. 根据用户组名称或编码批量查询用户组基础信息
根据用户组名称或编码批量获取到用户组基础信息,包含名称,编码,所属应用
12.1.1. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | UserDefineRoleGroupRpcFacade |
| 函数名 | getUserDefineRoleGroupInfo |
12.1.2. 请求参数
UserDefineRoleGroupReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| name | String | 否 | 用户组名称 |
| codeList | List | 否 | 用户组编码列表(单次请求不超过100条) |
| pageIndex | int | 是 | 页码 |
| pageSize | int | 是 | 每页数量(不超过1000) |
12.1.3. 响应格式
UserDefineRoleGroupSimpleResDTO:
| 参数 | 类型 | 描述 |
| name | String | 用户组名称 |
| code | String | 用户组编码 |
| appId | String | 归属应用ID |
示例:
{
"status": 1,
"message": null,
"data": [
{
"name": "用户组1",
"code": "code1",
"appId": "M010007"
},
{
"name": "用户组1",
"code": "code2",
"appId": "M010007"
}
],
"totalCount": 1390,
"pageSize": 10,
"pageIndex": 1
}
12.2. 通过授权用户组编码查用户组成员账号
根据用户组编码获取到用户组成员账号
12.2.1. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | UserDefineRoleGroupRpcFacade |
| 函数名 | getUserDefineRoleGroupMember |
12.2.2. 请求参数
UserDefineRoleGroupMemberReqDTO:
| 参数 | 类型 | 是否必填 | 描述 |
| userDefineRoleGroupCode | String | 是 | 用户组编码 |
12.2.3. 响应格式
示例:
{
"status": 1,
"message": null,
"data": [
{
"123",
"456",
"789"
}
]
}
12.3. 根据成员账号批量查询所属用户组
12.3.1. 接口路径
| 包名 | com.aliyun.fsi.insurance.acl.rpc |
| 类名 | UserDefineRoleGroupRpcFacade |
| 函数名 | getUserDefineRoleGroupInfoByAccId |
12.3.2. 请求参数
| 参数 | 类型 | 是否必填 | 描述 |
| accIdList | List | 是 | 账号列表(单次请求不超过100条) |
12.3.3. 响应格式
UserDefineRoleGroupMemberResDTO:
| 参数 | 类型 | 描述 |
| accId | String | 账号 |
| userDefineRoleGroupSimpleResDTOList | List | 用户组信息 |
UserDefineRoleGroupSimpleResDTO:
| 参数 | 类型 | 描述 |
| name | String | 用户组名称 |
| code | String | 用户组编码 |
| appId | String | 归属应用ID |
示例:
{
"status": 1,
"message": null,
"data": [
{
"accId":"1010001111",
"userDefineRoleGroupSimpleResDTOList":[
{
"name": "用户组1",
"code": "code1",
"appId": "M010007"
},
{
"name": "用户组1",
"code": "code2",
"appId": "M010007"
}
]
}
]
}