This URL deletes an existing custom role.
Resource URL
DELETE /role/{roleName}
Request Parameters
URL Parameter
| Field Name | Description | Data Type | Mandatory |
|---|---|---|---|
| roleName | Name of the custom role that is to be deleted | String | Yes |
Response Parameters
Following fields are returned if the request parameters are correct, otherwise error details are returned.
| Field Name | Description | Data Type |
|---|---|---|
| status | Value 1 indicates the resource is deleted successfully | Number |
Example
Request
DELETE https://<NSM_IP>/sdkapi/role/{CustomRole}
Response
{
"status":1
}
Error Information
Following error codes are returned by this URL:
| No | HTTP Error Code | SDK API errorId | SDK API errorMessage |
|---|---|---|---|
| 1 | 400 | 9504 | The role that you want to delete is in use |