Permanently delete a specific role by roleId

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Permanently deletes the role identified by roleId. The default Administrator role cannot be deleted.

Endpoints

Request URL

https://{server-hostname}:8383/emsapi/roles/{roleId}

Scope

Admin.DELETECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

acceptstringMandatory
application/deleteRole.v1+jsonapplication/deleteRole.v1+jsonCopied!

Specifies the expected response format. Set to application/deleteRole.v1+json to receive the role deletion response in JSON format.

- Path Parameters

roleIdstringMandatory

Unique role identifier. To get role id click here. Get Role Id

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request DELETE \
  --url https://appdomain/emsapi/roles/{roleId} \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'accept: application/deleteRole.v1+json'
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON object
Hide Sub-Attributes
messagestring

Success message confirming role deletion.

successCodestring

Success code for the role deletion operation.

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Role deletion success response.

Copied!
  {
    "message": "Role Security Auditor has been deleted successfully.",
    "successCode": "40021"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.