Group Management
1 Get a list of groups
Basic Information
- Interface description: query group information, group information includes group ID and group name, where group ID is used to group the profile. The MoreLogin application needs to be updated to version 2.9.0 and above.
Request Parameters
Body parameter, non-mandatory parameters can not be passed, the format of the parameter is JSON.
Parameter Name | Type | Required | Description |
pageNo | integer(int64) | YES | Current page, default: 1 |
pageSize | integer(int64) | YES | Number of articles per page, default: 20 |
groupName | string | NO | Search by Group Name |
Example of a request
{
"pageNo": 1,
"pageSize": 10,
"groupName": ""
}
Return data
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": {
"current": 0,
"dataList": [
{
"id": 0, // Group ID
"groupName": "" // Group name
}
],
"pages": 0,
"total": 0
},
"requestId": "", // Operation Request ID
}
2 Add group
Basic information
- Interface description: add group, after adding successfully, can be used to group the profile. The name of groups can not be duplicated. After the successful creation of the group, the group ID will be returned. The MoreLogin application needs to be updated to version 2.9.0 and above.
Request Parameters
Body parameter, non-required parameters can be left out, the format of the parameter is JSON.
Parameter name | Type | Required | Description |
groupName | string | YES | Group name |
Example of a request
{
"groupName": ""
}
Return Data
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": 0, // The data returned by the operation
"requestId": "", // Operation Request ID
}
3 Modify grouping information
Basic information
- Interface description: The group name can be modified and the name cannot be duplicated. The MoreLogin application needs to be updated to version 2.14.0 and above.
Request Parameters
Body parameter, non-required parameters can be left out, the format of the parameter is JSON.
Parameter name | Type | Required | Description |
groupName | string | YES | Group name |
id | integer(int64) | YES | Group ID |
Example of a request
{
"groupName": "",
"id": 0
}
Return Data
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": true,
"requestId": "", // Operation Request ID
}
4 Delete group
Basic information
- Interface description: Delete the specified group. The MoreLogin application needs to be updated to version 2.14.0 and above.
Request Parameters
Body parameter, non-required parameters can be left out, the format of the parameter is JSON.
Parameter Name | Type | Required | Description |
ids | array | YES | Group ID |
isDeleteAllEnv | boolean | NO | Whether to delete the profiles in the group at the same time, default: false false: do not delete, true: delete |
Example of a request
{
"ids": [],
"isDeleteAllEnv": false
}
Return Data
{
"code": 0, // Return result code 0:Normal Other codes are exceptions.
"msg": "", // Error message
"data": true,
"requestId": "", // Operation Request ID
}