delete_workgroup

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

Syntax

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

The following fields can be used in the delete_workgroup method:

Field name	Obligation	Definition/Value
domain	Required	The name of the domain to which the workgroup belongs.
workgroup	Required	The name of the workgroup that you want to delete.

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

Field name	Obligation	Description/Value
error	Returned if success = false	A text string that explains the error.
error_number	Returned if success = false	A number that represents the error.
success	Always returned	Indicates whether the request was successful or not. Allowed values are true and false.

Request

{
  "credentials": {
    "user": "[email protected]",
    "password": "pencil75"
  },
  "domain": "example.com",
  "workgroup": "finance"
}

Response

{
   "success": true
}