{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","settings":"","results":{"codes":[]},"method":"post","examples":{"codes":[]},"params":[]},"next":{"description":"","pages":[]},"title":"Add members to a volume","type":"endpoint","slug":"add-members-to-a-volume","excerpt":"","body":"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`).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Request\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/storage/volumes/{volume_id}/members\",\n      \"language\": \"text\",\n      \"name\": \"Path\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example request\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/storage/volumes/rfranklin/my-first-volume/members HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl  -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"Content-type: application/json\\\" -X POST \\\"https://api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/members\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Description of value\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n_required_\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\",\n    \"1-0\": \"`Content-type`\\n_required_\",\n    \"1-1\": \"`application/json`\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`volume_id`\\n_required_\",\n    \"1-0\": \"`description`\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type of value\",\n    \"0-1\": \"String\",\n    \"1-1\": \"String\",\n    \"0-2\": \"The volume that you want to query, which consists of username of the volume owner and volume name, for example `rfranklin/my-first-volume`.\",\n    \"h-2\": \"Description of value\",\n    \"1-2\": \"An optional description of this volume.\",\n    \"2-0\": \"`service`\\n_required_\",\n    \"2-1\": \"Object\",\n    \"2-2\": \"This object should contain the information about the cloud service that this volume represents.\\n\\nSee the <code><a href=\\\"http://docs.sevenbridges.com/v1.0/docs/create-a-volume-v2#section-the-service-object\\\">service</code> object section</a> below for an explanation of its structure.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Request body\n\nIn the body, you should enter a list of key-value pairs. The keys and the values they take are described in the following table.\n[block:parameters]\n{\n  \"data\": {\n    \"2-2\": \"Set 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.\",\n    \"3-0\": \"`copy`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Set 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.\",\n    \"4-0\": \"`write`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"Set this to `true` to grant `write` permissions or `false` to remove them. `write` permissions allow a volume member to export files from the Platform to the volume.\",\n    \"5-0\": \"`admin`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Set this to `true` to grant admin permissions or `false` to remove them.\",\n    \"2-0\": \"`read`\",\n    \"2-1\": \"String\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`username`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"The Cavativa username of the collaborator you wish to invite to your volume.\",\n    \"1-0\": \"`Permissions`\\n_required_\",\n    \"1-1\": \"Object\",\n    \"1-2\": \"This object contains information about the permissions granted to the user being added.\\n\\nPermissions 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.\"\n  },\n  \"cols\": 3,\n  \"rows\": 6\n}\n[/block]\n##Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"username\\\": \\\"crickandwatson\\\",\\n  \\\"permissions\\\": {\\n    \\\"read\\\": true,\\n    \\\"copy\\\": true,\\n    \\\"write\\\": false,\\n    \\\"admin\\\": false\\n  }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\n[See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.](ref:api-status-codes) \n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example response body\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"username\\\": \\\"crickandwatson\\\",\\n    \\\"email\\\": \\\"crickandwatson:::at:::sbgenomics.com\\\",\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/members/members/dba4c487-4d9b-48c6-ba7c-62371568a1e5\\\",\\n    \\\"permissions\\\": {\\n        \\\"write\\\": false,\\n        \\\"read\\\": true,\\n        \\\"copy\\\": false,\\n        \\\"admin\\\": false\\n    },\\n    \\\"type\\\": \\\"TEAM\\\",\\n    \\\"id\\\": \\\"dba4c487-4d9b-48c6-ba7c-62371568a1e5\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","updates":[],"order":100,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"59a42cb3d5bfa1000f4d2a64","project":"5773dcfc255e820e00e1cd4d","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5773dcfc255e820e00e1cd51","5773df36904b0c0e00ef05ff","577baf92451b1e0e006075ac","577bb183b7ee4a0e007c4e8d","577ce77a1cf3cb0e0048e5ea","577d11865fd4de0e00cc3dab","578e62792c3c790e00937597","578f4fd98335ca0e006d5c84","578f5e5c3d04570e00976ebb","57bc35f7531e000e0075d118","57f801b3760f3a1700219ebb","5804d55d1642890f00803623","581c8d55c0dc651900aa9350","589dcf8ba8c63b3b00c3704f","594cebadd8a2f7001b0b53b2","59a562f46a5d8c00238e309a","5a2aa096e25025003c582b58","5a2e79566c771d003ca0acd4","5a3a5166142db90026f24007","5a3a52b5bcc254001c4bf152","5a3a574a2be213002675c6d2","5a3a66bb2be213002675cb73","5a3a6e4854faf60030b63159","5c8a68278e883901341de571","5cb9971e57bf020024523c7b","5cbf1683e2a36d01d5012ecd","5dc15666a4f788004c5fd7d7","5eaff69e844d67003642a020","5eb00899b36ba5002d35b0c1","5eb0172be179b70073dc936e","5eb01b42b36ba5002d35ebba","5eb01f202654a20136813093","5eb918ef149186021c9a76c8","5f0839d3f4b24e005ebbbc29","5f893e508c9862002d0614a9","6024033e2b2f6f004dfe994c"],"_id":"5773dcfc255e820e00e1cd50","__v":36,"createdAt":"2016-06-29T14:36:44.812Z","releaseDate":"2016-06-29T14:36:44.812Z","project":"5773dcfc255e820e00e1cd4d"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Cavatica API","slug":"api","order":19,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"user":"5613e4f8fdd08f2b00437620","createdAt":"2017-08-28T14:46:11.673Z","githubsync":"","__v":0,"parentDoc":null}

Get started

Cavatica Projects

Find apps

Bring data to Cavatica

Set metadata associated with a file

Collaborate securely

BRING YOUR TOOLS

Docker

Developer tools

EDIT AN APP

Tool wrapping tips and tricks

Describe your tool (Legacy)

Browse public datasets

Run an analysis

Task Execution

Review a task

Kids First studies

Cavatica Datasets

Cavatica API

Connect cloud storage

SBFS (Beta)

BULK API ACTIONS

ASYNC BULK ACTIONS

DRS API

WES API

CAVATICA DATASETS API (Advanced Access)

Data Cruncher

SBFS (Beta)

SBFS Command reference

postAdd 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`). [block:api-header] { "type": "basic", "title": "Request" } [/block] [block:code] { "codes": [ { "code": "https://cavatica-api.sbgenomics.com/v2/storage/volumes/{volume_id}/members", "language": "text", "name": "Path" } ] } [/block] [block:api-header] { "type": "basic", "title": "Example request", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "POST /v2/storage/volumes/rfranklin/my-first-volume/members HTTP/1.1\nHost: cavatica-api.sbgenomics.com\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f75", "language": "http", "name": null }, { "code": "curl -s -H \"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\" -H \"Content-type: application/json\" -X POST \"https://api.sbgenomics.com/storage/volumes/rfranklin/my-first-volume/members\"", "language": "curl", "name": "cURL" } ], "sidebar": true } [/block] ###Header Fields [block:parameters] { "data": { "h-0": "Key", "h-1": "Description of value", "0-0": "`X-SBG-Auth-Token`\n_required_", "0-1": "Your Cavatica [authentication token](doc:get-your-authentication-token).", "h-2": "", "1-0": "`Content-type`\n_required_", "1-1": "`application/json`" }, "cols": 2, "rows": 2 } [/block] ###Path parameters [block:parameters] { "data": { "0-0": "`volume_id`\n_required_", "1-0": "`description`", "h-0": "Key", "h-1": "Data type of value", "0-1": "String", "1-1": "String", "0-2": "The volume that you want to query, which consists of username of the volume owner and volume name, for example `rfranklin/my-first-volume`.", "h-2": "Description of value", "1-2": "An optional description of this volume.", "2-0": "`service`\n_required_", "2-1": "Object", "2-2": "This object should contain the information about the cloud service that this volume represents.\n\nSee the <code><a href=\"http://docs.sevenbridges.com/v1.0/docs/create-a-volume-v2#section-the-service-object\">service</code> object section</a> below for an explanation of its structure." }, "cols": 3, "rows": 1 } [/block] ##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. [block:parameters] { "data": { "2-2": "Set 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.", "3-0": "`copy`", "3-1": "String", "3-2": "Set 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.", "4-0": "`write`", "4-1": "String", "4-2": "Set this to `true` to grant `write` permissions or `false` to remove them. `write` permissions allow a volume member to export files from the Platform to the volume.", "5-0": "`admin`", "5-1": "String", "5-2": "Set this to `true` to grant admin permissions or `false` to remove them.", "2-0": "`read`", "2-1": "String", "h-0": "Key", "h-1": "Data type", "h-2": "Description", "0-0": "`username`", "0-1": "String", "0-2": "The Cavativa username of the collaborator you wish to invite to your volume.", "1-0": "`Permissions`\n_required_", "1-1": "Object", "1-2": "This object contains information about the permissions granted to the user being added.\n\nPermissions 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." }, "cols": 3, "rows": 6 } [/block] ##Example request body [block:code] { "codes": [ { "code": "{\n \"username\": \"crickandwatson\",\n \"permissions\": {\n \"read\": true,\n \"copy\": true,\n \"write\": false,\n \"admin\": false\n }\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] [See a list of Seven Bridges Platform-specific response codes that may be contained in the body of the response.](ref:api-status-codes) [block:api-header] { "type": "basic", "title": "Example response body", "sidebar": true } [/block] [block:code] { "codes": [ { "code": "{\n \"username\": \"crickandwatson\",\n \"email\": \"[email protected]\",\n \"href\": \"https://cavatica-api.sbgenomics.com/v2/storage/volumes/rfranklin/my-first-volume/members/members/dba4c487-4d9b-48c6-ba7c-62371568a1e5\",\n \"permissions\": {\n \"write\": false,\n \"read\": true,\n \"copy\": false,\n \"admin\": false\n },\n \"type\": \"TEAM\",\n \"id\": \"dba4c487-4d9b-48c6-ba7c-62371568a1e5\"\n}", "language": "json" } ], "sidebar": true } [/block]