Skip to main content

​
URL structure

where {itemId} is the ID of a Secure Object or collection.

​
Supported methods and overview

  • DELETE - used to allow a Covata user to remove themselves as a collaborator from a Secure Object or collection (i.e. item), based on the item’s ID.
This method takes no parameters.

​
Detailed description

This API endpoint allows the currently authenticated Covata user* to remove themselves as a collaborator from either a Secure Object or a collection, based on this item’s ID. The item’s ID can be obtained by calling the <access-service>/api/v1/items API endpoint, which retrieves a list of information associated with Secure Objects and collections that can be filtered using various ‘search’ criteria. If the item’s ID is that of a collection, then the currently authenticated user is removed from all items contained within this collection.
This functionality is equivalent to a Covata user either removing their access to secure content (shared with them) through the Safe Share web application as well as Safe Share for Windows or iOS.
* The currently authenticated user is determined by the access token passed in the header of requests to this endpoint.

​
Supported roles and conditions

This API endpoint supports the following Covata user roles (as described in the Covata Platform Administrator’s Guide) and conditions:
  • Originator - a Covata user with this role can call this endpoint for an item they are a collaborator on.
  • Collaborator
The Covata Platform’s resources available to one of these Covata users (above) is determined by the access token passed in the header of requests to this endpoint.

​
Required headers

The appropriate access token as the Bearer token:
  • Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6

​
Returns

If the request succeeded, then an HTTP response status 200 OK is returned.