Delete Role

Deletes a role.

URL

https://{{HOST}}/security/role?v={version}&roleId={roleId}

Method

DELETE

Required IMS Scopes

  • securityapi_all

Versions Supported

  • 2.0 (Default)

URL Query Parameters

Name Description Example Type
v
optional
Version of the api to use /role?v=2.0 number

Request Header Parameters

Type Value Description
Authorization
required
Bearer {access_token} IMS access token

Example

Request

curl -X DELETE 
  'https://{{HOST}}/security/role?v=2.0&roleId=testRole' 
  -H 'Authorization: Bearer {access_token}'

Response

{
  "success": true
}

Errors

Error Description
Error Name Description of Error

Response Body Parameters

Name Description Schema
Object Name Description object definition
success Description object definition