On this page

    Get a User

    Note:
    Version Requirement:

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

    This API returns the information of a user by ID.

    Endpoint Syntax

    GET /api/v3/user/{id}
    GET /api/v3/user/by-name/{userName}
    

    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.

    {
      "@type": "EnterpriseUser",
      "id": "aaf2dc39-8c95-450b-a542-2e0192ea7150",
      "name": "test_user",
      "firstName": "first",
      "lastName": "last",
      "tag": "UmGtb/FB3LI=",
      "roles": [
        {
          "id": "1bce89d1-1b39-4717-bf1f-bfb0d9653146",
          "name": "PUBLIC",
          "type": "SYSTEM"
        },
        {
          "id": "d4f430eb-af38-4514-8fed-226d1ddbea6a",
          "name": "test_role2",
          "type": "INTERNAL"
        }
      ],
      "type": "LOCAL"
    }
    

    Response Codes

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

    Example

    curl -X GET --location "http://localhost:9047/api/v3/user/aaf2dc39-8c95-450b-a542-2e0192ea7150" \
        -H "Authorization: _dremiopu2916f7aph06aahv4ksu4life" \
        -H "Content-Type: application/json" \
        -H "Accept: application/json"