Get a List of Roles

Version Requirement:

This functionality is for Dremio v16.0+ Enterprise Edition only.

This API returns a list of existing roles. The first 25 results are displayed (pagination is not currently supported).

Endpoint Syntax

GET /api/v3/role?startIndex={startIndex}&count={count}&filter={query}

Parameters

  • {query} - A query string to search roles having the prefix in name
  • {startIndex} - The number-based index of the first query result. A value of less than 1 shall be interpreted as 1.
  • count - Non-negative integer. This specifies the desired maximum number of search results per page. The default value will be set by the backend.

Required Privileges

All users executing this Rest API must have the MANAGE GRANTS privilege assigned to receive a response output.

Response Output

This is the standard response output for the API.

  • totalResults - The total number of results matching the query. This will always be a non-negative integer.
  • itemsPerPage - The number of query results that are returned in the response.
  • startIndex - The number-based index of the first result in the response.
{“data”: [{“id”: “5ebcf4fa-ef8d-4bb4-8660-b18b18f661d6”,
  “name”: “admin”,
  “memberCount”: 20,
 “description”: “description”,
   “tag”: “abcd”
},
  …
  ],
  "totalResults":100,
  "itemsPerPage":10,
  "startIndex":1
}

Response Codes

  • 200 - Success.
  • 400 - Invalid source type.
  • 403 - The user executing the API request lacks the MANAGE GRANTS permission.
  • 404 - The role is not found.

Example

curl -X GET --location "http://localhost:9047/api/v3/role” \
    -H "Authorization: _dremiohrr395nv31g8k610616tucp91g" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"