The delete_workgroup method deletes a specified workgroup.



The workgroup must be empty, that is, it must not have any users assigned to it.


  <credentials object>,
    "domain": <domain name>,
    "workgroup": <workgroup name> 

Request fields for delete_workgroup

The following fields can be used in the delete_workgroup method:

Field nameObligationDefinition/Value
domainRequiredThe name of the domain to which the workgroup belongs.
workgroupRequiredThe name of the workgroup that you want to delete.

Response fields for delete_workgroup

The following fields may be returned in response to the delete_workgroup method:

Field nameObligationDescription/Value
errorReturned if success = falseA text string that explains the error.
error_numberReturned if success = falseA number that represents the error.
successAlways returnedIndicates whether the request was successful or not. Allowed values are true and false.

Examples for delete_workgroup


  "credentials": {
    "user": "[email protected]",
    "password": "pencil75"
  "domain": "",
  "workgroup": "finance"


   "success": true