Fx.auth

Fx.auth: Authorization role

1. Query with personnel as the subject

Fx.auth.getUser()

return type

AuthUserAPI

(1). Refer to AuthUserAPI

2. Query with role as subject

Fx.auth.getRole()

return type

AuthRoleAPI

(1). Refer to AuthRoleAPI

Reference class com.fxiaoke.functions.api.AuthUserAPI

1. Use personnel as the subject to query all roles

getRolesByUsers(<java.lang.Integer roleSource>, <java.util.List userIds>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleSource | Integer | role, inner: 1, outer: 2 |
| userIds | List | user ids |

return type

com.fxiaoke.functions.model.APIResult

Return value description

List, list of roles

Java example

APIResult ret = Fx.auth.getUser().getRolesByUsers(1, Lists.newArrayList("1001"));
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

def(boolean error, List data, String message) = Fx.auth.user.getRolesByUsers(1, ["1001"])
if (error) {
  log.info("error: " + message)
} else {
  log. info(data)
}

2. Use the role as the subject to query all personnel

getUsersByRoleCodes(<java.util.List roleCodes>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCodes | List | role codes |

return type

com.fxiaoke.functions.model.APIResult

Return value description

List

Java example

APIResult ret = Fx.auth.getUser().getUsersByRoleCodes(Lists.newArrayList("00000000000000000000000000000009"));
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

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. Add role

batchAddUserRole(<java.util.List roleCodes>, <java.lang.Boolean updateMajorRole>, <java.lang.String majorRole>, <java.util.List userIds>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCodes | List | role codes |
| updateMajorRole | Boolean | Whether to update the main role |
| majorRole | String | major role |
| userIds | List | user ids |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

APIResult ret = Fx.auth.getUser().batchAddUserRole(Lists.newArrayList("00000000000000000000000000000009"), true,"000000000000000000000000000000009", Lists.newArrayList("1069"));
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

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. Set the role of the person, subject to the submitted parameters

batchSetUserRoles(<java.util.List roleCodes>, <java.lang.String majorRole>, <java.util.List userIds>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCodes | List | role codes |
| majorRole | String | major role |
| userIds | List | user ids|

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

APIResult ret = Fx.auth.getUser().batchSetUserRoles(Lists.newArrayList("00000000000000000000000000000009"), "0000000000000000000000000000014", Lists.newArrayList("1046"));
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

def(boolean error, Map data, String message) = Fx.auth.user.batchSetUserRoles(["00000000000000000000000000000009"],"0000000000000000000000000000014",["1046"])
if (error) {
  log.info("error: " + message)
} else {
  log. info(data)
}

5. Take the role as the subject and delete the person

deleteByUserIds(<java.lang.String roleCode>, <java.util.List userIds>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCode | String | role code |
| userIds | List | user ids |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

APIResult ret = Fx.auth.getUser().deleteByUserIds("00000000000000000000000000000009", Lists.newArrayList("1267"));
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

def(boolean error, Map data, String message) = Fx.auth.user.deleteByUserIds("00000000000000000000000000000009", ["1267"])
if (error) {
  log.info("error: " + message)
} else {
  log. info(data)
}

Reference class com.fxiaoke.functions.api.AuthRoleAPI

1. Query role list

getRoleList(<java.lang.Integer roleSource>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleSource | Integer | role, inner: 1, outer: 2|

return type

com.fxiaoke.functions.model.APIResult

Return value description

List

Java example

APIResult ret = Fx.auth.getRole().getRoleList(1);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

def(boolean error, List data, String message) = Fx.auth.role.getRoleList(1)
if (error) {
  log.info("error: " + message)
} else {
  log. info(data)
}

2. Add management function permission role

createAdminRole(<java.lang.String roleName>, <java.lang.String description>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleName | String | role name |
| description | String | Role description |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleName = "Customized management function permissions";
String description = "Description of custom management function permissions";
APIResult ret = Fx.auth.getRole().createAdminRole(roleName, description);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

String roleName = "Customized management function permissions"
String description = "Customized management function permission 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. Add roles

createRole(<java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleName | String | role name |
| description | String | Role description |
|roleGroupCode | String | Role grouping |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleName = "Customized management function permissions";
String description = "Description of custom management function permissions";
String roleGroupCode = "roleGroupCode1";
APIResult ret = Fx.auth.getRole().createRole(roleName, description);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

String roleName = "Customized management function permissions"
String description = "Customized management function permission 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. Delete role

deleteRole(<java.lang.String roleCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCode | String | role code |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleCode = "1234";
APIResult ret = Fx.auth.getRole().deleteRole(roleCode);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

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. Update roles

updateRole(<java.lang.String roleCode>, <java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCode | String | role code|
| roleName | String | role name |
| description | String | Role description |
| roleGroupCode | String | role group code |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleCode = "1234";
String roleName = "Customized management function permissions";
String description = "Description of custom management function permissions";
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 example:

String roleCode = "1234"
String roleName = "Customized management function permissions"
String description = "Customized management function permission 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. Copy role, cannot copy the role of CRM administrator

replicateRole(<java.lang.String fromRoleCode>, <java.lang.String roleName>, <java.lang.String description>, <java.lang.String roleGroupCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| fromRoleCode | String | Source Role Code |
| roleName | String | role name |
| description | String | Role description |
| roleGroupCode | String | role group code |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String fromRoleCode = "1234";
String roleName = "Customized management function permissions";
String description = "customDefined management function authority 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 example:

String fromRoleCode = "1234"
String roleName = "Customized management function permissions"
String description = "Customized management function permission 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. Delete the management function permission role

deleteAdminRole(<java.lang.String roleCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCode | String | role code |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleCode = "1234";
APIResult ret = Fx.auth.getRole().deleteAdminRole(roleCode);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

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. Modify the management function permission role

updateAdminRole(<java.lang.String roleCode>, <java.lang.String roleName>, <java.lang.String description>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleCode | String | role code |
| roleName | String | role name |
|description| String | Role description |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleCode = "1234";
String roleName = "Customized management function permissions";
String description = "Description of custom management function permissions";
APIResult ret = Fx.auth.getRole().updateAdminRole(roleCode, roleName, description);
if (ret. isError()) {
    log.info(ret.message());
} else {
    log.info(ret.getData());
}

Groovy example:

String roleCode = "1234"
String roleName = "Customized management function permissions"
String description = "Customized management function permission 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. Copy role, cannot copy the role of CRM administrator

replicateAdminRole(<java.lang.String roleName>, <java.lang.String description>, <java.lang.String sourceRoleCode>)

Parameter Description

| parameter | type | description |
| ------------ | ------------ | ----------------------- ----------------------------------------- |
| roleName | String | role name |
| description | String | Role description |
| sourceRoleCode | String | roleCode of the copied role |

return type

com.fxiaoke.functions.model.APIResult

Return value description

Map

Java example

String roleName = "Customized management function permissions";
String description = "Description of custom management function permissions";
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 example:

String roleName = "Customized management function permissions"
String description = "Customized management function permission 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)
}