List Users

Version Requirement:

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

This API returns a list of existing users.

Endpoint Syntax

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

Parameters

  • query - A query string to search users with prefix in username, firstname, lastname, and email. It is case sensitive like the /v3/users/ search endpoint.
  • 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.

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. The following parameters are defined:

  • totalResults - The total number of results matching the query. It 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”: “username”,
  “first name”: “dre”,
  “last name”: “mio”,
   “email”: “a@b.c”,
  “status”: “active”, //(DCS only)
  “type”: “LOCAL”, //(software only, LOCAL or REMOTE)
  “roles”: [{“id”: “5ebcf4fa-ef8d-4bb4-8660-b18b18f66123”,
    “name”: “admin”, “Tag”: “tag”},…],
  “tag”: “user_tag”},
   …],
  "totalResults":100,
  "itemsPerPage":10,
  "startIndex":1
}

Response Codes

  • 200 - Success.
  • 400 - Invalid request or duplicate user name.
  • 403 - The user executing the API request lacks the MANAGE GRANTS permission.
  • 404 - The user is not found.

Example

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