Delete

[POST] .../v1/usergroup/delete

Deletes group users. Use this destructive method to delete a user group after ensuring that it is no longer needed for users, roles or hierarchy. The method validates id, checks user-group delete permission 8, deletes the group through the persistent layer and returns row_affected. The request body is required and id must be positive; child groups, assigned users, role links or protected system data may cause the persistent layer to reject deletion. Missing body, invalid id, denied permission, referenced-data conflicts and database errors are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id Int64 Required System group ID.

Request Example

{
  "id": 3
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": []
  }
}