View all the User Roles

Use the following details to view all the User Roles using REST interface:

HTTP Method

GET

Endpoint URL

See the REST Service Endpoint topic for more details.

Resource

/admin/role

Request Parameters

Provide values for the following parameters:

Parameter Name Data Type Mandatory
queryData query Yes

Request Model

Media Type: application/json

Response Model

{
  "data": {
    "matches": [
      {
        "createdOn": "2016-08-01T17:33:36.302Z",
        "id": "string",
        "permissions": [
          "string"
        ],
        "updatedOn": "2016-08-01T17:33:36.302Z"
      }
    ],
    "nbResponses": 0,
    "startIndex": 0
  },
  "duration": 0,
  "result": {
    "code": "string",
    "message": "string",
    "params": [
      "string"
    ]
  },
  "startTimestampMS": 0
}

Response Codes and Descriptions

Response Code Description
401 Unauthorized
403 Forbidden
404 Not Found