Skip to main content
Version: current [24.2.x]

User Privileges Enterprise

Use the User API to retrieve privilege information for Dremio users.

User Privileges Object
{
"data": [
{
"name": "\"@dremio\".\"1c0accd3-e8c0-1d55-23a2-0ff6529f6c00\"",
"type": "PDS",
"privilege": "ALTER"
},
{
"name": "\"@dremio\".\"1c0accd3-e8c0-1d55-23a2-0ff6529f6c00\"",
"type": "PDS",
"privilege": "SELECT"
},
{
"name": "\"@dremio\".Business",
"type": "FOLDER",
"privilege": "ALTER"
},
{
"name": "\"@dremio\".Business",
"type": "FOLDER",
"privilege": "SELECT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "SELECT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "INSERT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "DROP"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "CREATE_TABLE"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "ALTER"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "SELECT"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "MANAGE_GRANTS"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "MODIFY"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "ALTER_REFLECTION"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "VIEW_REFLECTION"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "ALTER"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "SELECT"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "MANAGE_GRANTS"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "ALTER"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "MANAGE_GRANTS"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "DELETE"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "MODIFY"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "VIEW"
}
]
}

User Privileges Attributes

data

[Object]

Information about the privileges the specified user has for the catalog objects in the current organization, up to a maximum of 100 privileges. Each object in the data array describes a privilege on a specific catalog object.

data

name

String (UUID)

Name of the object to which the privilege applies. The name includes the entity's parent space or folder, if any.

Example "@dremio"."1c0accd3-e8c0-1d55-23a2-0ff6529f6c00"


type

String

Type of the object to which the privilege applies.

Enum SPACE, SOURCE, HOME, FOLDER, PDS, VDS, FUNCTION

Example PDS


privilege

String

Name of the privilege that the user has for the object. Available privileges vary for different object types.

Example ALTER

Retrieving User Privileges

Retrieve the specified user's privileges.

Method and URL
GET /api/v3/user/{id}/privilege

Parameters

id

path

String (UUID)

Unique identifier of the user whose privileges you want to retrieve.

Example b9dbebc7-bc3b-4d56-9154-31762ab65a43


Example Request
curl -X GET 'https://{DREMIO_ORIGIN}/api/v3/user/b9dbebc7-bc3b-4d56-9154-31762ab65a43/privilege' \
--header 'Authorization: Bearer <PersonalAccessToken>' \
--header 'Content-Type: application/json'
Example Response
{
"data": [
{
"name": "\"@dremio\".\"1c0accd3-e8c0-1d55-23a2-0ff6529f6c00\"",
"type": "PDS",
"privilege": "ALTER"
},
{
"name": "\"@dremio\".\"1c0accd3-e8c0-1d55-23a2-0ff6529f6c00\"",
"type": "PDS",
"privilege": "SELECT"
},
{
"name": "\"@dremio\".Business",
"type": "FOLDER",
"privilege": "ALTER"
},
{
"name": "\"@dremio\".Business",
"type": "FOLDER",
"privilege": "SELECT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "SELECT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "INSERT"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "DROP"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "CREATE_TABLE"
},
{
"name": "Samples",
"type": "SOURCE",
"privilege": "ALTER"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "SELECT"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "MANAGE_GRANTS"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "MODIFY"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "ALTER_REFLECTION"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "VIEW_REFLECTION"
},
{
"name": "\"testing\"",
"type": "SPACE",
"privilege": "ALTER"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "SELECT"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "MANAGE_GRANTS"
},
{
"name": "\"testing\".\"NYC-taxi-trips\"",
"type": "VDS",
"privilege": "ALTER"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "MANAGE_GRANTS"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "DELETE"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "MODIFY"
},
{
"name": "taxi",
"type": "SCRIPT",
"privilege": "VIEW"
}
]
}

Response Status Codes

200

OK

401

Unauthorized

404

Not Found

405

Method Not Allowed