Get Role ID

Version Requirement:

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

This API updates the information of a role with an ID or adds/removes roles to which this role belongs.

Endpoint Syntax

PUT /api/v3/role/{id}

Required Privileges

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

Response Input

This is the standard response input for the API.

{
 "id": "aa6d94e6-8cb7-4331-a881-e24945d74ad1",
 "name": "test_role",
 “Description”: “description”,
 "roles": [
   {
     "id": "d4f430eb-af38-4514-8fed-226d1ddbea6a",
     "name": "test_role2",
     "type": "INTERNAL"
   }
 ]
}

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 PUT --location "http://automaster.drem.io:9047/api/v3/role/aa6d94e6-8cb7-4331-a881-e24945d74ad1" \
    -H "Authorization: _dremiopu2916f7aph06aahv4ksu4life" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d "{
          \"id\": \"aa6d94e6-8cb7-4331-a881-e24945d74ad1\",
          \"name\": \"test_role\",
          \"roles\": [
            {
              \"id\": \"d4f430eb-af38-4514-8fed-226d1ddbea6a\",
              \"name\": \"test_role2\",
              \"type\": \"INTERNAL\"
            }
          ]
        }"