Modify a project member's permissions

This call edits a user's permissions in a specified project. It can only be successfully made by a user who has admin permissions in the project.

https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/{project_owner}/{project}/members/{member}/permissions

Request

Example request

PATCH /v2/projects/RFranklin/test/members/crick/permissions HTTP/1.1
Host: api.sb.biodatacatalyst.nhlbi.nih.gov
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74

curl --data '{"write": true}'  -s -H "X-SBG-Auth-Token: 1e43fEXampLEa5523dfd14exAMPle3e5" -H "content-type: application/json" -X PATCH "https://api.sb.biodatacatalyst.nhlbi.nih.gov/v2/projects/RFranklin/test/members/crick/permissions"

Header Fields

Name	Description
`X-SBG-Auth-Token` required	Your Platform authentication token.

Path parameters

Name	Description
`project`	The short name of the project containing the project member.
`project_owner`	The owner of the project containing the project member.
`member`	The project member whose permissions you are editing.

Query parameters

Name	Data type	Description
`fields`	string	Selector specifying a subset of fields to include in the response.

Request body

Inside the body of the call you should enter a set of key-value pairs. The following table describes the values you should enter.

Key	Data type of value	Description of value
`read`	Boolean: `true` or `false`	User can view file names, metadata, and workflows. They cannot view file contents. 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`.
`write`	Boolean: `true` or `false`	User can add, modify, and remove files and workflows in a project. Set value to `true` to assign the user copy permission. Set to `false` to remove copy permission.
`copy`	Boolean: `true` or `false`	User can view file content, copy, and download files from a project. Set value to `true` to assign the user copy permission. Set to `false` to remove copy permission.
`execute`	Boolean: `true` or `false`	User can execute workflows and abort tasks in a project. Set value to `true` to assign the user copy permission. Set to `false` to remove copy permission.
`admin`	Boolean: `true` or `false`	User can modify another user's permissions on a project, add or remove people from the project and manage funding sources. They also have all of the above permissions. Set value to `true` to assign the user copy permission. Set to `false` to remove copy permission.

Example request body

{
      "write": true,
}

Response

See a list of response codes that may be contained in the body of the response.

Example response body

{
  "write": true,
  "read": true,
  "copy": false,
  "execute": false,
  "admin": false
}