Add members to a volume

This call returns the members of a specific volume. The volume is specified as volume_id and consists of the owner and name of a volume (for example rfranklin/my-first-volume).

Request

https://cgc-api.sbgenomics.com/v2/storage/volumes/{volume_id}/members

Example request

POST /v2/storage/volumes/rfranklin/my-first-volume/members HTTP/1.1
Host: cgc-api.sbgenomics.com
X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74
curl  -s -H "X-SBG-Auth-Token: 3210a98c1db9318fa9d9273156740f74" -H "Content-type: application/json" -X POST "https://cgc-api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/members"

Header Fields

KeyDescription of value
X-SBG-Auth-Token
required
Your CGC authentication token.
Content-type
required
application/json

Path parameters

KeyData type of valueDescription of value
volume_id
required
StringThe volume that you want to query, which consists of username of the volume owner and volume name, for example rfranklin/my-first-volume.

Request body

In the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.

KeyData typeDescription
usernameStringThe CGC username of the collaborator you wish to invite to your volume.
Permissions
required
ObjectThis object contains information about the permissions granted to the user being added.

Permissions include listing the contents of a volume, importing files from the volume to the CGC, exporting files from the CGC to the volume, and admin privileges.
readStringSet this to true to grant read permissions or false to remove them. read permissions allow a volume member to browse the contents of the volume.
copyStringSet this to true to grant copy permissions or false to remove them. copy permissions allow a volume member to import the contents of the volume to the Platform.
writeStringSet this to true to grant write permissions or false to remove them. write permissions allow a volume member to export files from the CGC to the volume.
adminStringSet this to true to grant admin permissions or false to remove them.

Example request body

{
  "username": "crickandwatson",
  "permissions": {
    "read": true,
    "copy": true,
    "write": false,
    "admin": false
  }
}

Response

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

Example response body

{
    "username": "crickandwatson",
    "email": "[email protected]",
    "href": "https://cgc-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/members/members/ece8b123-5a6e-48e9-aa9a-9871568a1e5",
    "permissions": {
        "write": false,
        "read": true,
        "copy": false,
        "admin": false
    },
    "type": "TEAM",
    "id": "ece8b123-5a6e-48e9-aa9a-9871568a1e5"
}
Language