Delete a User Group

This API is used to delete a user group.

URL: /userGroup

Type: DELETE

Parameters


Param Type	Name	Description	Field Type
`Header`	sessionId (or) Token	Use either Session Id or Token received after login	`String`
`Query`	gwkey	Tenant Key. Needed only in case of multitenant installations	`String`
`Query`	gwsource**	Source from which the request is triggered (for example, web, external)	`String`
`Payload`	userGroupName **	Name of the user group to be deleted	`String`

** - Mandatory value

Possible Response Message and Code


HTTP Code	Description	Response Message
400	Bad request	Invalid Request.
200	OK	UserGroup deleted successfully.
404	Not Found	UserGroup does not exist.
403	Forbidden	Current user(s) usergroup(s) cannot be deleted.

Sample Request/Response

Use Case

Add a user group with the name group_1.

Request URL

https://appviewxapi.com/avxapi/userGroup?userGroupName= group_1&gwkey=f000ca01;gwsource=external

Request Payload

Response

 {
 "response": "UserGroup deleted successfully",
 "message": "UserGroup deleted successfully",
 "appStatusCode": null,
 "tags": null,
 "headers": null
 }