Skip to main content
Version: current

Privileges Enterprise

Use the Catalog API to retrieve information about available privileges on the different types of catalog objects.

Privileges Object
{
  "availablePrivileges": [
    {
      "grantType": "SPACE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "MUTABLE_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "CREATE_TABLE",
        "DELETE",
        "DROP",
        "INSERT",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "TRUNCATE",
        "UPDATE",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "ARP_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "EXTERNAL_QUERY",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "FOLDER_IN_MUTABLE_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "CREATE_TABLE",
        "DELETE",
        "DROP",
        "INSERT",
        "MANAGE_GRANTS",
        "SELECT",
        "TRUNCATE",
        "UPDATE",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "FOLDER",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "PDS",
      "privileges": [
        "ALTER",
        "DELETE",
        "INSERT",
        "MANAGE_GRANTS",
        "SELECT",
        "TRUNCATE",
        "UPDATE"
      ]
    },
    {
      "grantType": "VDS",
      "privileges": [
        "ALTER",
        "MANAGE_GRANTS",
        "SELECT"
      ]
    },
    {
      "grantType": "FUNCTION",
      "privileges": [
        "ALTER",
        "EXECUTE",
        "MANAGE_GRANTS",
        "MODIFY"
      ]
    }
  ]
}

Privileges Attributes​

{{< api-section file="data/software-api/privileges.json" data="privilegesAttributes" >}}

availablePrivileges​

{{< api-section file="data/software-api/privileges.json" data="availablePrivilegesAttributes" >}}

Retrieving All Catalog Privileges​

Retrieve information about the available privileges on each type of object in the catalog.

Method and URL
GET /api/v3/catalog/privileges

Parameters​

{{< api-section file="data/software-api/privileges.json" data="retrievePrivilegesParameters" >}}


Example Request
curl -X GET 'https://{hostname}/api/v3/catalog/privileges' \
--header 'Authorization: _dremio{tokenstring}' \
--header 'Content-Type: application/json'
Example Response
{
  "availablePrivileges": [
    {
      "grantType": "SPACE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "MUTABLE_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "CREATE_TABLE",
        "DELETE",
        "DROP",
        "INSERT",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "TRUNCATE",
        "UPDATE",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "ARP_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "EXTERNAL_QUERY",
        "MANAGE_GRANTS",
        "MODIFY",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "FOLDER_IN_MUTABLE_SOURCE",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "CREATE_TABLE",
        "DELETE",
        "DROP",
        "INSERT",
        "MANAGE_GRANTS",
        "SELECT",
        "TRUNCATE",
        "UPDATE",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "FOLDER",
      "privileges": [
        "ALTER",
        "ALTER_REFLECTION",
        "MANAGE_GRANTS",
        "SELECT",
        "VIEW_REFLECTION"
      ]
    },
    {
      "grantType": "PDS",
      "privileges": [
        "ALTER",
        "DELETE",
        "INSERT",
        "MANAGE_GRANTS",
        "SELECT",
        "TRUNCATE",
        "UPDATE"
      ]
    },
    {
      "grantType": "VDS",
      "privileges": [
        "ALTER",
        "MANAGE_GRANTS",
        "SELECT"
      ]
    },
    {
      "grantType": "FUNCTION",
      "privileges": [
        "ALTER",
        "EXECUTE",
        "MANAGE_GRANTS",
        "MODIFY"
      ]
    }
  ]
}

Response Status Codes​

{{< api-responses file="data/software-api/privileges.json" data="retrievePrivilegesResponseCodes" >}}