Get Member List

Version Requirement:

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

This API returns a list of members of this role. When a type is given, the API returns with a list of members for the required type.

Endpoint Syntax

GET /api/v3/role/{id}/member?startIndex={startIndex}&count={count}

Required Privileges

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

Parameters

  • startIndex - The number-based index of the first query result. A value less than 1 is interpreted as 1.
  • count - Non-negative integer. Specifies the desired maximum number of search results per page.
  • totalResults - The total number of results matching the query. Non-negative integer required.
  • itemsPerPage - The number of query results that are returned in the response.
  • startIndex - The number-based index of the first result in the response.

Response Output

This is the standard response output for the API.

{ “data”: {[
  {“id”: “5ebcf4fa-ef8d-4bb4-8660-b18b18f661d7”,
   “name”: “a role”,
 “description”: “description”,
   “Type”: “role”},
   …
  ],
   "totalResults":100,
   "itemsPerPage":10,
   "startIndex":1
}

Response Codes

  • 200 - Success.
  • 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/5ebcf4fa-ef8d-4bb4-8660-b18b18f661d6/roles” \
    -H "Authorization: _dremiohrr395nv31g8k610616tucp91g" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"