Add members of an Enterprise to a volume

post

https://api.sbgenomics.com/v2/storage/volumes/{volume-owner}/{volume-name}/members

This call adds a member to a specific volume. Volume identifier specified in the {volume-owner}/{volume-name} format is also known as volume ID and can be, for example rfranklin/my-first-volume.

Enterprise users can add individual members, teams or whole divisions to a volume using the type parameter.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Example request body

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

Path Params

volume-owner

string

required

Username of the volume owner.

volume-name

string

required

The name of the volume you want to add members to.

Body Params

username

string

required

Specify the ID of the division member you are adding to the volume using the following format: division_id/username. In case you are adding a team or a division, you should enter the ID of that team or division.

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.

type

string

Specify the type of user: USER - to add an individual user TEAM - to add a whole team DIVISION - to add a whole division If this parameter is omitted, the default value used will be USER.

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

Language

Loading…

Response

Choose an example:

application/json

Example request body

200200