Add a User Group
Add a new user group to the system.
URL: /usergroup
Type: POST
Parameter
| Param Type | Name | Description | Field Type |
|---|---|---|---|
| Header | sessionId ** | Session Id 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 | name** | Name of the user group. | String |
| Payload | description | Description of the user group | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 400 | Bad request | User group name cannot be null, empty or whitespace alone |
| 201 | Created | User group added successfully |
| 409 | Conflict | User group with the given name already exists |
Sample Request/Response
Use Case
Add a user group with a valid name.
Request URL
http://appviewxapi.com/avxapi/usergroup?gwkey=f000ca01&gwsource=external
Request Payload
{
"payload": {
"name": "usergroup_1",
"description": "Adding user group"
}
}
Response
{
"response": " Usergroup added successfully",
"message": " Usergroup added successfully",
"appStatusCode": null,
"tags": null,
"headers": null
}