Get the list of built-in permissions

Edit online

Description

URL

scheme://domain:port/platform/ws/permissions

Description

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

Gets the list of built-in permissions.

HTTP-Method

GET

Parameters

None

Request

Request-Method

GET

Request-URI

/platform/ws/permissions

Request-Header

Name

Value

Accept

application/xml or application/json

Message-body

empty

Response

Response-Code

  • 200 Successful: Request was successful.
  • 403 Forbidden: logged on user does not have the Cluster administrator role.
  • 404 Not Found: No permissions found.
  • 500 Internal Server Error: Exception occurred

Response-Header

Name

Value

Content-Type

application/xml or application/json

Message-body

 Success Message

If successful, returns the list of built-in permissions.

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

<permissions total =”5”>
<atom:link rel="self" href="%s"/>
<permission name="view_control" />
<permission name="view_control_configure" />
<permission name="view_configure" />
<permission name="view" />
<permission name="none" />
</permissions>
  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: Get built-in permissions

# Request
GET /platform/ws/permissions HTTP/1.1
Host: www.example.org
# Response
200 Successful
Content-Type: application/xml;
<permissions total =”3”>
<atom:link rel="self" href="http://www.example.org/ws/permissions"/>

<permission name="view" />
<permission name="view_control" />
<permission name="view_control_configure" />
<permission name="view_configure" />
<permission name="none" />
</permissions>