Fx.auth：权限角色
1. getUser 以人员为主语进行查询
Fx.auth.getUser()
返回值类型
AuthUserAPI
(1).参考AuthUserAPI
2. getRole 以角色为主语进行查询
Fx.auth.getRole()
返回值类型
AuthRoleAPI
(1).参考AuthRoleAPI
3. getOuterUser 以外部人员为主语进行查询
Fx.auth.getOuterUser()
返回值类型
AuthOuterUserAPI
(1).参考AuthOuterUserAPI
参考类 com.fxiaoke.functions.api.AuthUserAPI
1. 以人员为主语，查询所有的角色
getRolesByUsers(<java.lang.Integer roleSource>, <java.util.List userIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleSource | Integer | 角色，内部：1，外部：2 |
| userIds | List | 用户id |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: List，角色列表
Java举例
APIResult ret = Fx.auth.getUser().getRolesByUsers(1, Lists.newArrayList("1001"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, List data, String message) = Fx.auth.user.getRolesByUsers(1, ["1001"])
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
2. 以角色为主语，查询所有人员
getUsersByRoleCodes(<java.util.List roleCodes>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCodes | List | 角色codes |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: List
Java举例
APIResult ret = Fx.auth.getUser().getUsersByRoleCodes(Lists.newArrayList("00000000000000000000000000000009"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
List roleCodes = ["00000000000000000000000000000009"]
def(boolean error, List data, String message) = Fx.auth.user.getUsersByRoleCodes(roleCodes)
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
3. 追加角色
batchAddUserRole(<java.util.List roleCodes>, <java.lang.Boolean updateMajorRole>, <java.lang.String majorRole>, <java.util.List userIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCodes | List | 角色codes |
| updateMajorRole | Boolean | 是否更新主角色 |
| majorRole | String | 主角色 |
| userIds | List | 用户id |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.auth.getUser().batchAddUserRole(Lists.newArrayList("00000000000000000000000000000009"), true,"00000000000000000000000000000009", Lists.newArrayList("1069"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, Map data, String message) = Fx.auth.user.batchAddUserRole(["00000000000000000000000000000009"], true,"00000000000000000000000000000009", ["1069"])
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
4. 设置人员的角色，以提交参数为准
batchSetUserRoles(<java.util.List roleCodes>, <java.lang.String majorRole>, <java.util.List userIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCodes | List | 角色code |
| majorRole | String | 主要角色 |
| userIds | List | 用户id |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.auth.getUser().batchSetUserRoles(Lists.newArrayList("00000000000000000000000000000009"), "00000000000000000000000000000014", Lists.newArrayList("1046"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, Map data, String message) = Fx.auth.user.batchSetUserRoles(["00000000000000000000000000000009"],"00000000000000000000000000000014",["1046"])
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
5. 以角色为主语，删除人员
deleteByUserIds(<java.lang.String roleCode>, <java.util.List userIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCode | String | 角色code |
| userIds | List | 用户ids |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
APIResult ret = Fx.auth.getUser().deleteByUserIds("00000000000000000000000000000009", Lists.newArrayList("1267"));
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, Map data, String message) = Fx.auth.user.deleteByUserIds("00000000000000000000000000000009", ["1267"])
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
6. 查询企业使用crm角色的数量
queryUsedCRM()
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
Map
Java举例
APIResult ret = Fx.auth.getUser().queryUsedCRM();
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, Map data, String message) = Fx.auth.user.queryUsedCRM()
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
参考类 com.fxiaoke.functions.api.AuthRoleAPI
1. 查询角色列表
getRoleList(<java.lang.Integer roleSource>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleSource | Integer | 角色，内部：1，外部：2 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: List
Java举例
APIResult ret = Fx.auth.getRole().getRoleList(1);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
def(boolean error, List data, String message) = Fx.auth.role.getRoleList(1)
if (error) {
log.info("error: " + message)
} else {
log.info(data)
}
2. 添加管理功能权限角色
createAdminRole(<java.lang.String roleName>, <java.lang.String description>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleName | String | 角色名称 |
| description | String | 角色描述 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
APIResult ret = Fx.auth.getRole().createAdminRole(roleName, description);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
def (boolean error, Map returnObj, String message) = Fx.auth.role.createAdminRole(roleName, description)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
3. 添加角色
createRole(<java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleName | String | 角色名称 |
| description | String | 角色描述 |
| roleGroupCode | String | 角色分组 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
String roleGroupCode = "roleGroupCode1";
APIResult ret = Fx.auth.getRole().createRole(roleName, description);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
String roleGroupCode = "roleGroupCode1"
def (boolean error, Map returnObj, String message) = Fx.auth.role.createRole(roleName, description, roleGroupCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
4. 删除角色
deleteRole(<java.lang.String roleCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCode | String | 角色code |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleCode = "1234";
APIResult ret = Fx.auth.getRole().deleteRole(roleCode);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleCode = "1234"
def (boolean error, Map returnObj, String message) = Fx.auth.role.deleteRole(roleCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
5. 更新角色
updateRole(<java.lang.String roleCode>, <java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCode | String | 角色code |
| roleName | String | 角色名称 |
| description | String | 角色描述 |
| roleGroupCode | String | 角色分组code |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleCode = "1234";
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
String roleGroupCode = "roleGroupCode1";
APIResult ret = Fx.auth.getRole().updateRole(roleCode, roleName, description, roleGroupCode);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleCode = "1234"
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
String roleGroupCode = "roleGroupCode1"
def (boolean error, Map returnObj, String message) = Fx.auth.role.updateRole(roleCode, roleName, description, roleGroupCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
6. 复制角色,不能复制CRM管理员的角色
replicateRole(<java.lang.String fromRoleCode>, <java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| fromRoleCode | String | 来源Role Code |
| roleName | String | 角色名称 |
| description | String | 角色描述 |
| roleGroupCode | String | 角色分组code |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String fromRoleCode = "1234";
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
String roleGroupCode = "roleGroupCode1";
APIResult ret = Fx.auth.getRole().replicateRole(fromRoleCode, roleName, description, roleGroupCode);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String fromRoleCode = "1234"
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
String roleGroupCode = "roleGroupCode1"
def (boolean error, Map returnObj, String message) = Fx.auth.role.replicateRole(fromRoleCode, roleName, description, roleGroupCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
7. 删除管理功能权限角色
deleteAdminRole(<java.lang.String roleCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCode | String | 角色码 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleCode = "1234";
APIResult ret = Fx.auth.getRole().deleteAdminRole(roleCode);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleCode = "1234"
def (boolean error, Map returnObj, String message) = Fx.auth.role.deleteAdminRole(roleCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
8. 修改管理功能权限角色
updateAdminRole(<java.lang.String roleCode>, <java.lang.String roleName>, <java.lang.String description>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleCode | String | 角色码 |
| roleName | String | 角色名称 |
| description | String | 角色描述 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleCode = "1234";
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
APIResult ret = Fx.auth.getRole().updateAdminRole(roleCode, roleName, description);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleCode = "1234"
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
def (boolean error, Map returnObj, String message) = Fx.auth.role.updateAdminRole(roleCode, roleName, description)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
9. 复制角色,不能复制CRM管理员的角色
replicateAdminRole(<java.lang.String roleName>, <java.lang.String description>, <java.lang.String sourceRoleCode>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| roleName | String | 角色名称 |
| description | String | 角色描述 |
| sourceRoleCode | String | 被复制的角色的roleCode |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
返回的数据类型: Map
Java举例
String roleName = "自定义管理功能权限";
String description = "自定义管理功能权限描述";
String sourceRoleCode = "sourceRoleCode1";
APIResult ret = Fx.auth.getRole().replicateAdminRole(roleName, description, sourceRoleCode);
if (ret.isError()) {
log.info(ret.message());
} else {
log.info(ret.getData());
}
Groovy举例：
String roleName = "自定义管理功能权限"
String description = "自定义管理功能权限描述"
String sourceRoleCode = "sourceRoleCode1"
def (boolean error, Map returnObj, String message) = Fx.auth.role.replicateAdminRole(roleName, description, sourceRoleCode)
if (error){
log.info('=====' + message)
} else {
log.info('returnObj:' + returnObj)
}
10. 给人员分配管理角色，可分配crm管理员
addRoleWithDepartmentToEmployeesByAppId(<java.lang.Integer currentEmployeeId>, <java.util.List employeeIds>, <java.util.Map roleCodeAndDepartmentIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| currentEmployeeId | Integer | 操作人id |
| employeeIds | List | 用户id |
| roleCodeAndDepartmentIds | Map | 角色code、分管范围等信息 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
Map
Groovy举例：
List employeeIds = [1000]
def currentEmployeeId = 1000
def roleCodeAndDepartmentIds = [
"roleCode":"31",
"departmentIds":[999999]
]
def(boolean error, List data, String message) = Fx.auth.role.addRoleWithDepartmentToEmployeesByAppId(currentEmployeeId, employeeIds, roleCodeAndDepartmentIds)
参考类 com.fxiaoke.functions.api.AuthOuterUserAPI
1. 以角色为主语，删除互联人员
deleteByUserIds(<java.lang.String appId>, <java.lang.String outTenantId>, <java.lang.String roleCode>, <java.util.List userIds>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| appId | String | 应用Id，先固定传CRM |
| outTenantId | String | 下游企业Id |
| roleCode | String | 角色code |
| userIds | List | 用户ids |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
Map
Groovy举例：
def (boolean error, Map returnObj, String message) = Fx.auth.outerUser.deleteByUserIds("CRM", "323376297","00000000000000000000000000000009", ["1000"])
if (error){
log.info('error: ' + message)
} else {
log.info('returnObj:' + returnObj)
}
2. 覆盖更新互联用户的所有角色
updateRoles(<java.lang.String appId>, <java.lang.String outTenantId>, <java.util.List userIds>, <java.lang.String majorRole>, <java.util.List roleCodes>)
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| appId | String | 应用Id，先固定传CRM |
| outTenantId | String | 下游企业Id |
| userIds | List | 用户ids |
| majorRole | String | 主角色 |
| roleCodes | List | 覆盖的角色 |
返回值类型
com.fxiaoke.functions.model.APIResult
返回值说明
Map
Groovy举例：
def (boolean error, Map returnObj, String message) = Fx.auth.outerUser.updateRoles("CRM", "300030180", ["300383629"],"5b6817bbe4b066655a6397e4", ["5b6817bbe4b066655a6397e4"])
if (error){
log.info('error: ' + message)
} else {
log.info('returnObj:' + returnObj)
}