Delete a Role
This API is used to delete a role.
URL: /role
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 multi-tenant installations. | String |
Query |
gwsource** | Source from which the request is triggered (for example, web, external). | String |
Query |
roleName** | Name of the role to delete. | String |
** - Mandatory value
Possible Response Message and Code
| HTTP Code | Description | Response Message |
|---|---|---|
| 400 | Bad request | RoleName value is missing. |
| 200 | OK | Role deleted successfully |
| 404 | Not Found | RoleName does not exist |
| 409 | Forbidden | Role(s) which have active user(s) cannot be deleted. |
Sample Request/Response
Use Case
Delete a role with name role_1.
Request URL
https://appviewxapi.com/avxapi/role?roleName=role_1&gwkey=f000ca01;gwsource=external
Request Payload
NA
Response
{
"response": "Role deleted successfully",
"message": "Role deleted successfully",
"appStatusCode": null,
"tags": null,
"headers": null
}