Seven Bridges knowledge centerDocumentation
API Reference

Get a dataset member's permissions

get https://cavatica-api.sbgenomics.com/v2

/datasets/{owner}/{dataset}/members/{username}/permissions

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

❗️

Heads Up!

This page documents the Advanced Access version (think "beta" but with fewer bugs) of the Datasets API functionality.

This returns the permissions of a specified user within a specified dataset.
Members may have the following permissions for a given dataset:

  • Read
  • Write
  • Copy
  • Execute
  • Admin

Permissions are granted at the dataset-level. You may, for instance, have admin permission in one project, execute permission in another, and read-only permission in a third.

https://cavatica-api.sbgenomics.com/v2/datasets/{owner}/{dataset}/members/{username}/permissions

Request

Example request

GET /v2/datasets/{owner}/{dataset}/members/{username}/permissions
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
X-SBG-advance-access: advance

curl -X GET -H "X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" "https://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/jane_smith/permissions"

Header fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.
X-SBG-Advance-Access
required		advance

Path parameters

NameData type
'owner'The owner of the dataset you are querying.
datasetThe name of the dataset you are querying.
usernameThe username of the member you are querying.

Response

See a list of CAVATICA-specific response codes that may be contained in the body of the response.
.

Example response body

{
  "write": true,
  "read": true,
  "copy": true,
  "execute": true,
  "admin": false
}
Language