Get details of a dataset member

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

❗️

Heads Up!

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

This call returns information about the specified dataset member.

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

Request

Example request

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

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 whose datasets you want to query.

dataset

The name of the dataset you are querying.

username

The 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

{
   "href": "http://cavatica-api.sbgenomics.com/v2/datasets/rfranklin/pcgc-chd-pa-01/members/jane_smith",
   "username": "jane_smith",
   "permissions": {
      "write": true,
      "read": true,
      "copy": true,
      "execute": true,
      "admin": false
    }
}
Language
Click Try It! to start a request and see the response here!