Modify a dataset member's permissions

/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 call overwrites permissions for a specified dataset member.

Dataset members may have the following permissions on CAVATICA:

  • Read
  • Write
  • Copy
  • Execute
  • Admin

Permissions are granted at the dataset-level. You may, for instance, have admin permission in one dataset, 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

PUT /v2/datasets/rfranklin/pcgc-chd-pa-01/members/robert_smith/permissions
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
Content-Type: application/json
X-SBG-advance-access: advance
curl -X DELETE -H "X-SBG-Auth-Token: 5f2d7a4d8186488694fa3dc3844b7b06" -H "x-sbg-advance-access: advance" -H "Content-Type: application/json" -d '' "https://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/robert_smith"

Header fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

X-SBG-Advance-Access
required

advance

Path parameters

Name

Data type

'owner'

The owner of the dataset you wish to overwrite the member's permissions for.

dataset

The name of the dataset containing the member.

username

The username of the member.

Request body

Key

Data type of value

Description of value

read

Boolean: true or false

All members of a dataset have read permissions by default.

Even if you try setting read permissions to false, they will still default to true.

write

Boolean: true or false

User can add, modify, and remove files and workflows in a dataset.

Set value to true to assign the user copy permission. Set to false to remove copy permission.

copy

Boolean: true or false

User can view file content, copy, and download files from a dataset.

Set value to true to assign the user copy permission.

Set to false to remove copy permission.

execute

Boolean: true or false

User can execute workflows and abort tasks in a dataset.

Set value to true to assign the user copy permission.

Set to false to remove copy permission.

admin

Boolean: true or false

User can modify another user's permissions on a dataset and add or remove people from the dataset.

They also have all of the above permissions.

Set value to true to assign the user copy permission.

Set to false to remove copy permission.

Example request body

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

Response

Example response body

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

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

Language
Click Try It! to start a request and see the response here!