API: Delete FileRun user accounts
| Target URL | /api.php/Core/!admin/users/delete |
| Required scope | admin |
| HTTP Method | POST |
| Output format | JSON |
Request Parameters Reference
| Parameter | Type | Required | Description |
|---|---|---|---|
| UIDS | array | Yes | Array of user ID integers |
| deleteHomeFolder | boolean | No | If included, this will cause the user(s) home folders to also be deleted. |
The response
Each account is deleted on its own. The data object is keyed by user ID and holds, for each one, success and message. The request as a whole is successful even when some of the accounts could not be deleted, so read data for the outcome of each.
1{
2 "success": true,
3 "msg": ["..."],
4 "data": {
5 "44": {
6 "success": true,
7 "message": "..."
8 },
9 "45": {
10 "success": false,
11 "message": "..."
12 }
13 }
14}