{"_id":"5b0e13ffc4664e0003c75ade","project":"5b0e13ffc4664e0003c75a66","version":{"_id":"5b0e13ffc4664e0003c75a67","project":"5b0e13ffc4664e0003c75a66","__v":4,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["5b0e13ffc4664e0003c75a68","5b0e13ffc4664e0003c75a69","5b0e13ffc4664e0003c75a6a","5b0e13ffc4664e0003c75a6b","5b0e13ffc4664e0003c75a6c","5b0e13ffc4664e0003c75a6d","5b0e13ffc4664e0003c75a6e","5b0e13ffc4664e0003c75a6f","5b0e13ffc4664e0003c75a70","5b0e13ffc4664e0003c75a71","5b0e13ffc4664e0003c75a72","5b0e13ffc4664e0003c75a73","5b0e13ffc4664e0003c75a74","5b0e13ffc4664e0003c75a75","5b0e13ffc4664e0003c75a76","5b0e13ffc4664e0003c75a77","5b0e13ffc4664e0003c75a89","5b0e13ffc4664e0003c75a8a","5b0e13ffc4664e0003c75a9d","5b0e13ffc4664e0003c75a9e","5b0e13ffc4664e0003c75a9f","5b0e13ffc4664e0003c75aa0","5b0e13ffc4664e0003c75aa1","5b0e13ffc4664e0003c75aa2","5b0e13ffc4664e0003c75aa3","5b0e13ffc4664e0003c75aa4","5b0e13ffc4664e0003c75aa5","5b0e13ffc4664e0003c75aa6","5b0e13ffc4664e0003c75aa7","5b0e13ffc4664e0003c75aa8","5b0e13ffc4664e0003c75aa9","5b0e13ffc4664e0003c75aaa","5b0e13ffc4664e0003c75aab","5b0e13ffc4664e0003c75aac","5b0e13ffc4664e0003c75aad","5b0e13ffc4664e0003c75aae","5b0e13ffc4664e0003c75aaf","5b0e13ffc4664e0003c75ab2","5bb3374f4306ad0003eb18e7","5bbf3c5373e72a000318362b","5bc065567d1cb0000384c649","5cbf19a5f9181f0033fbb968"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5b0e13ffc4664e0003c75a75","project":"5b0e13ffc4664e0003c75a66","version":"5b0e13ffc4664e0003c75a67","__v":0,"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-09-17T17:34:34.937Z","from_sync":false,"order":32,"slug":"api","title":"API Reference"},"user":"5613e4f8fdd08f2b00437620","__v":0,"parentDoc":null,"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-02T20:00:53.023Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","examples":{"codes":[]},"method":"post","auth":"required","params":[],"url":""},"isReference":true,"order":95,"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://f4c-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: f4c-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://f4c-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 [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 Platform 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 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://f4c-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]","excerpt":"","slug":"add-members-to-a-volume","type":"endpoint","title":"Add members to a volume"}

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://f4c-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: f4c-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://f4c-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 [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 Platform 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 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\": \"crickandwatson@sbgenomics.com\",\n \"href\": \"https://f4c-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]