Delete Group (EA)

Deletes an existing group and removes the association between the group and all of its devices. Requires admin permissions to run this API.

Note: This endpoint is currently in Early Availability.

Resource name: /api/v1/groups/{groupDisplayName}

Request Method: DELETE

Request parameters

Parameter Type Description
groupDisplayName string (path) Display name of the group to delete.

cUrl Example

Copy 
curl -X DELETE "https://<localhost>/api/v1/groups/FinanceGroup" \
    -H 'Cookie: PHPSESSID=5f1a3je95qqrn5fj0k3hhv7foc' \
    -H 'accept: */*'    

Status codes

Code Description
200 Group deleted successfully
400 Bad Request / invalid input
401 Unauthorized
403 User does not have permission to delete the group
404 Group not found
423 Locked
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Response parameters

parameter type description
error string Error label
description string Detailed explanation of the failure
fieldErrors object Validation errors for individual fields
field string Name of the invalid field
error string Description of the validation problem
status boolean Request success indicator
message string Human-readable message

Response example success 200

Copy 
"Group deleted successfully"                

Response example failure 400

Copy 
{
  "error": "Bad Request",
  "description": "Invalid groupDisplayName",
  "fieldErrors": [
    {
      "field": "groupDisplayName",
      "error": "must not be blank"
    }
  ]
}