Dremio Cloud
Dremio Software
 
On this page

    Get Role ID

    Note:
    Version Requirement:

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

    This API returns all information associated with a role ID, including members of that role. All members are returned up to 25 entries (pagination is not currently supported).

    Endpoint Syntax

    Method and URL 
    GET /api/v3/role/{id}
GET /api/v3/role/by-name/{roleName}

    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.

    Response output 
    {"id": "5ebcf4fa-ef8d-4bb4-8660-b18b18f661d6",
 "name": "admin",
 "tag": "abcd",
 "description": "description",
   "Roles": [
    {"id": "5ebcf4fa-ef8d-4bb4-8660-b18b18f66123",
    "type": "user",
    "name": "a user"
   }, …, 
   ]
}

    Response Codes

    • 200 - Success.
    • 403 - The user executing the API request lacks the MANAGE GRANTS permission.
    • 404 - The role is not found.

    Example

    Example request 
    curl -X GET --location "http://localhost:9047/api/v3/role/aa6d94e6-8cb7-4331-a881-e24945d74ad1" \
    -H "Authorization: _dremiopu2916f7aph06aahv4ksu4life" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"