Delete Role
Deletes a role with a given ID.
Request
URI
DELETE
https://{api_host}/api/v2/role/{id}
COPY
Path Parameters
string
id
Required
The ID of the role to delete. If you don't know the role's ID, run the Get all roles API call to return all roles and their IDs.
Responses
200
successful operation
Returns
ResponseContainerRoleDTO
of type(s)
application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"sampleLinkedGroups": [
"UserGroup Object"
],
"linkedGroupsCount": 0,
"sampleLinkedAccounts": [
"string"
],
"linkedAccountsCount": 0,
"restrictedPermissions": [
"string"
],
"properties": {
"nameEditable": false,
"usersRemovable": false,
"usersAddable": false,
"permsEditable": false,
"deletable": false
},
"permissions": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"createdEpochMillis": 0,
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string"
}
}
object
status
Required
status
object
response
Optional
response
Code Samples
COPY
curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v2/role/{id}