On this page

    Endpoints

    Introduced in Dremio 2.1.0.

    See Models for details on object representations.

    Only users with administrator privileges can use the accounts API.

    Get a user by id

    GET /api/v3/user/{id}
    

    Output

    User
    

    Response Codes

    403 - user does not have permission (has to be an administrator). 404 - user could not be found.

    Get a user by name

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

    Output

    User
    

    Response Codes

    403 - user does not have permission (has to be an administrator). 404 - user could not be found.

    Get a group by id

    Only available in Dremio Enterprise Edition.

    GET /api/v3/group/{id}
    

    Output

    Group
    

    Response Codes

    403 - user does not have permission (has to be an administrator). 404 - group could not be found.

    Get a group by name

    Only available in Dremio Enterprise Edition.

    GET /api/v3/group/by-name/{name}
    

    Output

    Group
    

    Response Codes

    403 - user does not have permission (has to be an administrator). 404 - group could not be found.