Delete role
Deletes the specified role.
This topic includes the following sections:
For a video demonstration of how to use this call, see Local-user-and-role-management-API.
Request
HTTP method: POST
URL: https://<hostname>:<port>/rsso/config/local/role/delete
Header: For header information, such as required authentication token, see Remedy-SSO-administrator-Login-and-Logout-calls.
Request body properties
Property | Type | Required | Description | Values | Default value |
|---|---|---|---|---|---|
roleName | String | Yes | Existing role name | User-provided value Existing user-defined value | NA |
Example request JSON
"roleName":"Admin role"
}
Response
If successful, this method deletes the specified role.
Response body properties
Property | Description |
|---|---|
code | Status code (see Status codes and messages) |
msg | Status |
data | NA |
Example response JSON
"code": 200,
"msg": "OK",
"data": {}
}
Status codes and messages
For more details about HTTP response codes, see HTTP response codes.
HTTP code | Message (msg) | Description |
|---|---|---|
200 | OK | Request succeeded |
400 |
| Bad request An error occurred while adding role. Some causes are
|
401 |
| Unauthorized |
Related topics