{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"required","method":"post","params":[],"results":{"codes":[]},"settings":"","examples":{"codes":[]}},"next":{"description":"","pages":[]},"title":"Add a member to a project","type":"endpoint","slug":"add-a-member-to-a-project","excerpt":"/projects/{project_owner}/{project}/members\n\nFor general information on the API, including formatting, parameters, and pagination, please see the [API Overview](the-api).","body":"This call adds a new user to a specified project. It can only be successfully made by a user who has admin permissions in the project.\n\nUsers may have the following permissions on Cavatica:\n  * Read\n  * Write\n  * Copy\n  * Execute\n  * Admin\n\nFor more information, see the documentation on [setting project member permissions](doc:set-permissions). Note that some user permissions imply others: for example, if you give a user admin permission, then they automatically receive read, write, copy and execute permissions.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}/members\",\n      \"language\": \"text\",\n      \"name\": \"API path\"\n    }\n  ]\n}\n[/block]\n##Request\n\n###Example request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"POST /v2/projects/rjfranklin/my-project/members HTTP/1.1\\nHost: cavatica-api.sbgenomics.com\\nX-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74\\n\",\n      \"language\": \"http\",\n      \"name\": null\n    },\n    {\n      \"code\": \"curl --data '{\\\"username\\\": \\\"Jane-Doe\\\", \\\"permissions\\\": { \\\"read\\\": true, \\\"write\\\": true, \\\"execute\\\": false}}' -s -H \\\"X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7\\\" -H \\\"content-type: application/json\\\" -X POST \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/members\\\"\",\n      \"language\": \"curl\",\n      \"name\": \"cURL\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Member permissions\",\n  \"body\": \"Requests to add a project member must include the key `permissions`. However, if you  do not include a value for some permission, it will be set to `false` by default. The exception to this rule is the `read` permission, which is the default permission on a project. It enables a user to read project data, including file names, but access file contents.\\n\\nFor more information, see the documentation on [setting permissions](doc:modify-a-project-members-permissions).\"\n}\n[/block]\n###Header Fields\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`X-SBG-Auth-Token`\\n<span style=\\\"color:red\\\"><i>required</i></span>\",\n    \"0-1\": \"Your Cavatica [authentication token](doc:get-your-authentication-token).\",\n    \"h-2\": \"\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]\n###Path parameters\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`project`\",\n    \"1-0\": \"`project_owner`\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"0-1\": \"The ID of the project you are adding someone to.\",\n    \"1-1\": \"The owner of the project you are adding someone to.\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]\n###Query parameters\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Data type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`fields`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"Selector specifying a subset of fields to include in the response.\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n##Request body\nInside the body of the call you should enter a set of key-value pairs. The following table describes the values you should enter.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Key\",\n    \"h-1\": \"Datatype of value\",\n    \"h-2\": \"Description of value\",\n    \"0-0\": \"`username`\",\n    \"0-1\": \"string\",\n    \"0-2\": \"The Cavatica username of the person you want to add to the project\",\n    \"1-0\": \"`permissions`\",\n    \"1-1\": \"array of key-value pairs. The keys are strings, and the values are Booleans.\",\n    \"1-2\": \"The possible keys are:\\n       `\\\"write\\\"`\\n       `\\\"read\\\"`\\n       `\\\"copy\\\"`\\n       `\\\"execute\\\"`\\n       `\\\"admin\\\"`\\nEach key may have the values `true` or `false`.\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"success\",\n  \"title\": \"Read permissions\",\n  \"body\": \"All members of a project have `read` permissions by default. Even if you try setting `read` permissions to `false`, they will still default to `true`.\"\n}\n[/block]\n###Example request body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"username\\\" : \\\"Jane_Doe\\\",\\n    \\\"permissions\\\": {\\n        \\\"read\\\" : true,\\n        \\\"write\\\": true,\\n        \\\"execute\\\": false\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n##Response\n\n[See a list of Cavatica-specific response codes that may be contained in the body of the response.](doc:api-status-codes) \n\n###Example response body\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"href\\\": \\\"https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/members/Jane_Doe\\\",\\n    \\\"username\\\": \\\"Jane_Doe\\\",\\n    \\\"permissions\\\": {\\n        \\\"write\\\": true,\\n        \\\"read\\\": true,\\n        \\\"copy\\\": false,\\n        \\\"execute\\\": true,\\n        \\\"admin\\\": false\\n    }\\n}\",\n      \"language\": \"json\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n<div align=\"right\"><a href=\"#top\">top</a></div>\n\n<hr>","updates":[],"order":26,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5774e45050a4121900e4a291","__v":3,"user":"575e85ac41c8ba0e00259a44","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"],"_id":"5773dcfc255e820e00e1cd50","__v":33,"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":18,"from_sync":false,"reference":false,"_id":"5773df36904b0c0e00ef05ff","createdAt":"2016-06-29T14:46:14.277Z","version":"5773dcfc255e820e00e1cd50","__v":0,"project":"5773dcfc255e820e00e1cd4d"},"githubsync":"","parentDoc":null,"createdAt":"2016-06-30T09:20:16.345Z","project":"5773dcfc255e820e00e1cd4d"}