Delete group
Relative path: /v1/groups/{groupUuid}
Delete Group referenced by uuid and any groups under it. If there are objects under deleted groups, all of them will be deleted as well. It is not possible to delete a group that has a linked entity (CUSTOMER, MSP, ...).
Query parameters
Name |
Type |
Description |
---|---|---|
releaseConsumedUnits |
boolean |
For any deleted object within the group all the associated units will be released. For devices, seat of any active product on deleted devices will be released (and can be used again). If there were multiple products active on the deleted device, all of them are deactivated. Similarly, if there is a product consuming users (e.g. mail server security), all the users will be released upon deletion of the device.
|
Parameters in path
Name |
Type |
Required |
Description |
---|---|---|---|
groupUuid |
string |
Yes |
Reference to the group which is root of deleted subtree. type: Group |
Responses
Display Schema instead of an Example or vice-versa
Code |
Description |
Example |
Schema |
---|---|---|---|
200 |
A successful response. |
{} |
{
"$ref": "v1DeleteGroupResponse",
"title": "empty",
"type": "object"
} |
default |
An unexpected error response. |
{ "code": 0, "message": "string", "details": [ { "@type": "string" } ] } |
{ "$ref": "rpcStatus", "code": { "type": "integer", "format": "int32" }, "message": { "type": "string" }, "details": [ { "$ref": "protobufAny", "@type": { "type": "string" } } ] } |
202 |
Response took too long and the request was cached. |
null |
[] |