Delete a role

Edit online

Description

URL

scheme://domain:port/platform/ws/role/{roleName}

Description

The logged on user must have view_configure permission on the setting resource to use this API.

Permanently removes the specified role.

Built-in roles cannot be deleted.

HTTP-Method

DELETE

Parameters

None

Request

Request-Method

DELETE

Request-URI

/platform/ws/role/{roleName}

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 204 Deleted: Role deletion was successful.
  • 403 Forbidden: logged on user does not have Cluster administrator role.
  • 500 Internal Server Error: Exception occurred.

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Failure Message

If not successful, returns an error message.

For additional information, refer to the schema file ./schemas/rbac/error.xsd.

<error>
  <message>
     %s
  </message>
</error>

Example: Delete the role test_role

# Request
DELETE /platform/ws/role/test_role HTTP/1.1
Host: www.example.org
Content-Type: application/xml;

# Response
204 Deleted