Delete an existing role
- Zuletzt aktualisiert2020/04/21
Delete an existing role
Use the Delete Existing Role API to delete an existing role in the Control Room.
Prerequisites
- Manage roles permission
-
Users who have
manage roles
permissions can delete roles. However, only custom roles can be deleted, the system-created roles, the first 16 roles with ID 1 to 16, cannot be deleted.
- JSON Web Token (JWT)
- All Control Room APIs require a JSON Web Token (JWT) to access the APIs. Generate an authentication token using the Authentication API. See Enterprise 11 Authentication API.
- URL:
http://<your_control_room_url>/v1/usermanagement/roles/{ID}
Replace the content in the angle brackets with your Control Room URL.
- Method: DELETE.
- Use the Swagger definition files installed with your Control Room to test the APIs. View the available Swagger
APIs at:
http://<your_control_room_url>/swagger/
. - You can also use a REST client to complete this task.
Procedure
Note: You can also run REST requests from a command terminal. The following is a curl
request example. This example is formatted for readability. Replace the text inside
the angle brackets,
<authentication_token>
, with your
authentication token.curl -X DELETE "http://<your_control_room_url>/v1/usermanagement/roles/22"
-H "accept: application/json"
-H "X-Authorization: <authentication_token>"
-H "Content-Type: application/json" -d "{22}"