Remove a dataset member

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

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 removes a member from the specified dataset. To remove a member, you need to have admin permissions for the dataset.

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

Request

Example request

DELETE /v2/datasets/rfranklin/pcgc-chd-pa-01/members/john_smith
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/john_smith"

Header fields

Name

Description

X-SBG-Auth-Token
required

Your CAVATICA authentication token.

X-SBG-Advance-Access
required

advance

Path parameters

Name

Description

owner

The owner of the dataset you are deleting.

dataset

The name of the dataset you are deleting.

username

The username of the member you want to remove.

Response

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!