Remove a project member

/projects/{project_owner}/{project}/members/{username}

For general information on the API, including formatting, parameters, and pagination, please see the API Overview.

This call removes a project member from a project. It can only be successfully run by a user who has admin privileges in the project.

For more information on permissions on CAVATICA, see the documentation on setting permissions.

https://cavatica-api.sbgenomics.com/v2/projects/{project_owner}/{project}/members/{username}

Request

Example request

DELETE /v2/projects/rfranklin/my-project/members/jane_doe HTTP/1.1
Host: cavatica-api.sbgenomics.com
X-SBG-Auth-Token: 3259c50e1ac5426ea8f1273259740f74
curl -s -H "X-SBG-Auth-Token: 6282d5e2121d43e7900e9d52b15845e7" -H "content-type: application/json" -X DELETE "https://cavatica-api.sbgenomics.com/v2/projects/RFranklin/my-project/members/Jane_Doe"

Header Fields

NameDescription
X-SBG-Auth-Token
required
Your CAVATICA authentication token.

Path parameters

NameDescription
project_owner
required
The CAVATICA username of the user who owns the project.
project
required
The ID of the project to access.
username
required
The CAVATICA username of the user you are removing.

Query parameters

NameData typeDescription
fieldsstringSelector specifying a subset of fields to include in the response.

Response

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


Language