REST API - DELETE User Group

This operation deletes a user group and transfers the ownership of entities such as alerts, scheduled policies, and workflows from the deleted user group to another user or user group.

Request

Syntax

Send the request using either the ID or the name:

DELETE <webservice>/UserGroup/{userGroupId}?newUserId={newUserId}&newUserGroupId={newUserGroupId} HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

Name

DELETE <webservice>/UserGroup/byName(userGroupName='{userGroupName}')?newUserId=byName(userName='{userName}')&newUserGroupId=byName(userGroupName='{userGroupName}') HTTP/1.1
Host: <host name>
Accept: application/xml
Authtoken: <authentication token>

where <webservice> is the root path used to route the API requests to the Web Server.

For more information, see Available Web Services for REST API.

Request Parameters

Name	Description	Required
userGroupId	The user group ID for the user group. If the user group ID is not known, use the GET User Group API to retrieve it.	Yes-for the request by ID
userGroupName	The user group name of the user group. If the user group name is not known, use the GET User Group API to retrieve it.	Yes-for the request by name
newUserId	The user ID to transfer ownership to. If the user ID is not known, use the GET User API to retrieve it.	Yes-for the request by ID. You must provide either a new user ID or a new user group ID. Use 0 as the value for the ID you are not sending.
newUserGroupId	The user group ID to transfer ownership to. If the user group ID is not known, use the GET User Group API to retrieve it.
userName As part of the newUserId parameter	The user name to transfer ownership to. If the user name is not known, use the GET User API to retrieve it.	Yes-for the request by name. You must provide either a new user name or a new user group name. Use empty quotation marks for the name you are not sending.
userGroupName As part of the newUserGroupId parameter	The user group name to transfer ownership to. If the user group name is not known, use the GET User Group API to retrieve it.

Request Headers

Name	Description
Host	The host name of the Web Server or Web Console used in the API request.
Accept	The format of the response. Valid values are: application/xml or application/json.
Authtoken	The authentication token received after successfully logging on. For details on receiving an authentication token, see Authentication.

Response

Response Parameters

Parameter	Description	Element
errorCode	The possible error codes. Valid values are: 0, successful completion. 2, a failure. a specific error code.	response
errorString	The description of the error code. Not all error codes have an error string.	response
userGroupId	The system-generated ID assigned to the user group. userGroupId is included in the response if the request is unsuccessful.	entity

Parameter

Description

Element

errorCode

The possible error codes.

Valid values are:

0, successful completion.
2, a failure.
a specific error code.

response

errorString

The description of the error code. Not all error codes have an error string.

response

userGroupId

The system-generated ID assigned to the user group. userGroupId is included in the response if the request is unsuccessful.

entity

Examples

Sample Request

This request uses the ID.

DELETE <webservice>/UserGroup/10?newUserId=0&newUserGroupId=22 HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

This request uses the name.

DELETE <webservice>/UserGroup/byName(userGroupName='laptop users')?newUserId=byName(userName='')&newUserGroupId=byName(userGroupName='backup admin') HTTP/1.1
Host: client.mydomain.com
Accept: application/xml
Authtoken: QSDK 38568012f4d1e8ee1841d283a47aa3ba78e124ea58354b5fc6
0f4dab8a63347d05cf5552484dafda3bfa4c5db84e580b1cb37bcf8e65b39f7f
8549a443e6f78a2c7be3f31b3d845e24776c835e498e8e883bb40c46bd15af4f
40ca94e823acedcdd4e9659e74b34a07a85c4586cd2ed914b6dce015874783ef7
68fda78183a4208930954a377f66eb56c8b92cexampl4s437a19317ca6ce7f323
3d5a01aca35dbad93468b833f2cf71010809006a937670adce711ca8be46638e8

Sample Response

This is the response when the user group is deleted.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_DeleteUserGroupResponse>
  <response errorCode="0"/>
</App_DeleteUserGroupResponse>

This is the response when the user group does not exist.

<?xml version="1.0" encoding="UTF-8" standalone="no" ?>
<App_DeleteUserGroupResponse>
  <response errorCode="2" errorString="User group does not exist.">
    <entity userGroupId="10"/>
  </response>
</App_DeleteUserGroupResponse>