User Group Details - RESTful API

Summary:

Delete a specified user group.

URL:

http(s)://{server hostname}/api/userGroups/{groupID}

Methods summary

DELETE Method detail

Methods summary

• DELETE Method - deletes the user group.

DELETE Method detail

Deletes the user group.

Response:

The updated list of user groups, as the 'GET Method' for api/userGroups would return them.

Examples:

INPUT
curl -u admin:admin https://localhost/api/userGroups/3?media=json -X DELETE

OUTPUT
{
  "items": [ {
      "serverId": "ee934fe2-1f4d-4f1e-a0b5-a87b261eb30a",
      "id": "1",
      "name": "Administrators"
    }, {
      "serverId": "ee934fe2-1f4d-4f1e-a0b5-a87b261eb30a",
      "id": "2",
      "name": "All Users"
    } ],
  "count": 2
}

INPUT
curl -u admin:admin https://localhost/api/userGroups/3?media=xml -X DELETE

OUTPUT
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<items count="2">
  <item xsi:type="namedItem" name="Administrators" id="1" serverId="ee934fe2-1f4d-4f1e-a0b5-a87b261eb30a" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
  <item xsi:type="namedItem" name="All Users" id="2" serverId="ee934fe2-1f4d-4f1e-a0b5-a87b261eb30a" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"/>
</items>