Data Source Permissions API

    This API can be used to enable, disable, list, add and remove permissions for a data source.

    Permissions can be set for a user or a team. Permissions cannot be set for Admins - they always have access to everything.

    The permission levels for the permission field:

    • 1 = Query

    Enables permissions for the data source with the given id. No one except Org Admins will be able to query the data source until permissions have been added which permit certain users or teams to query the data source.

    See note in the introduction for an explanation.

    Examples

    Example request:

    Example response:

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 35
    5. {"message":"Datasource permissions enabled"}

    Status codes:

    • 200 - Ok
    • 400 - Permissions cannot be enabled, see response body for details
    • 401 - Unauthorized
    • 403 - Access denied
    • 404 - Datasource not found

    POST /api/datasources/:id/disable-permissions

    Required permissions

    See note in the introduction for an explanation.

    Example request:

    1. POST /api/datasources/1/disable-permissions
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {}

    Example response:

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 35
    5. {"message":"Datasource permissions disabled"}

    Status codes:

    • 200 - Ok
    • 401 - Unauthorized
    • 403 - Access denied
    • 404 - Datasource not found

    GET /api/datasources/:id/permissions

    Gets all existing permissions for the data source with the given id.

    Required permissions

    See note in the introduction for an explanation.

    Examples

    Example request:

    Example response:

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 551
    5. {
    6.   "datasourceId": 1,
    7.   "enabled": true,
    8.   "permissions":
    10.     {
    11.       "id": 1,
    12.       "datasourceId": 1,
    13.       "userId": 1,
    14.       "userLogin": "user",
    15.       "userEmail": "user@test.com",
    16.       "userAvatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae56",
    17.       "permission": 1,
    18.       "permissionName": "Query",
    19.       "created": "2017-06-20T02:00:00+02:00",
    20.       "updated": "2017-06-20T02:00:00+02:00",
    21.     },
    22.     {
    23.       "id": 2,
    24.       "datasourceId": 1,
    25.       "teamId": 1,
    26.       "team": "A Team",
    27.       "teamAvatarUrl": "/avatar/46d229b033af06a191ff2267bca9ae56",
    28.       "permission": 1,
    29.       "permissionName": "Query",
    30.       "created": "2017-06-20T02:00:00+02:00",
    31.       "updated": "2017-06-20T02:00:00+02:00",
    32.     }
    33.   ]
    34. }

    Status codes:

    • 200 - Ok
    • 403 - Access denied
    • 404 - Datasource not found

    POST /api/datasources/:id/permissions

    See note in the introduction for an explanation.

    Examples

    Example request:

    1. POST /api/datasources/1/permissions
    2. Accept: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    6. {
    7.   "userId": 1,
    8.   "permission": 1
    9. }

    Example response:

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 35
    5. {"message":"Datasource permission added"}

    Adds a team permission for the data source with the given id.

    Example request:

    Example response:

    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 35
    5. {"message":"Datasource permission added"}

    Status codes:

    • 200 - Ok
    • 400 - Permission cannot be added, see response body for details
    • 401 - Unauthorized
    • 403 - Access denied
    • 404 - Datasource not found

    DELETE /api/datasources/:id/permissions/:permissionId

    Removes the permission with the given permissionId for the data source with the given id.

    Required permissions

    See note in the introduction for an explanation.

    Example request:

    1. DELETE /api/datasources/1/permissions/2
    2. Accept: application/json
    3. Content-Type: application/json
    4. Authorization: Bearer eyJrIjoiT0tTcG1pUlY2RnVKZTFVaDFsNFZXdE9ZWmNrMkZYbk
    1. HTTP/1.1 200 OK
    2. Content-Type: application/json; charset=UTF-8
    3. Content-Length: 35
    5. {"message":"Datasource permission removed"}

    Status codes:

    • 200 - Ok
    • 401 - Unauthorized
    • 403 - Access denied