Purpose

Deletes the specified role. A role cannot be deleted if there are any users assigned to it.

Note: System Administrator, User, and Tenant Administrator roles are predefined. These roles cannot be deleted.

URL

https://<myserver>:<port>/api/admin/roles/{id}

Method

DELETE

URL Parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The URL parameter {id} described in the following table is required.

Parameter Description Valid Values
{id} The ID of the role. The ID of a predefined role, such as a system administrator, or the ID of a role created by an administrator. The ID of a role cannot be changed.

Sample Server Success Response

   Status code: 204
   Successful response
{
  "success":true
}

Sample Server Failure Response 

{
  "error":{
    "code":222207924,
    "message":{
       "lang":"en-US",
       "value":"There is no Role with that id: 1234"
     }
   }
}

Authentication

Basic Authentication using Login ID and Password

Authorization

The user must have the Administrator (12) permission, or the DeleteRole (20) permission and administrative access on the tenant.