Add members to a volume

post

https://api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}/members

This call adds members to the specified volume.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}/members

Example request body

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

Response

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

Path Params

volume_owner

string

required

The username of the volume owner.

volume_name

string

required

The name of the volume you want to query.

Body Params

username

string

required

The Seven Bridges Platform username of the collaborator you wish to invite to your volume.

permissions

object

required

This 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 Platform, exporting files from the Platform to the volume, and admin privileges.

Headers

X-SBG-Auth-Token

string

required

Your Seven Bridges Platform authentication token. For security reasons, token will not be automatically populated in the generated code sample. Please replace <your-token-here> with your token before executing this call.

Response

If you are using Seven Bridges Platform EU, please use the following endpoint: https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}/members

Example request body

Response

200200

If you are using Seven Bridges Platform EU, please use the following endpoint: `https://eu-api.sbgenomics.com/v2/storage/volumes/{volume_owner}/{volume_name}/members`