Delete Role

This API enables you to remove an existing role from vCenter Chargeback Manager. A system role cannot be deleted. For more details on system roles, see Appendix.

User Privileges Required

You must be the creator of the role or have the Super User role.

Syntax

The syntax for calling this method is:

DELETE <Base_Url>/role/{roleId}

A sample API call is as follows:

DELETE https://123.123.123.123/vCenter-CB/api/role/517

Request Body Parameters

This API does not take any request XML.

API Response

The API returns an XML that indicates the status of the operation. A sample response is provided here.

Error Response

The following table explains the error codes displayed by the API.

Error Code

Description

VCB_ERR_INVALID_ROLE_ID

The specified role ID is invalid.

VCB_ERR_SYSTEM_ROLE_ALTER

The role corresponding to the given role ID is a system role.