URL structure

1 https://access-service.xy-company.com/api/v1/collaborations/items/{itemId}

where {itemId} is the ID of a file object/Secure Object or folder/collection.

Supported methods and overview

DELETE - allows a Cocoon Data user (whose access token is submitted in the request to this endpoint) to remove themselves as a collaborator from a file object/Secure Object or folder/collection (i.e. item), specified by itemId.

Note: This method takes no parameters.

Detailed description

This API endpoint allows a Cocoon Data user (whose access token is submitted in the request to this endpoint) to remove themselves as a collaborator from either a file object or folder, specified by itemId.

The item's ID can be obtained by calling the <access-service>/api/v1/organisations/{orgId}/items API endpoint, which retrieves a list of information associated with the file objects and folders that can be filtered using various 'search' criteria.

If the item's ID is that of a folder, then this user (whose access token is submitted in the request) is removed from all items contained within this folder.

Note: This functionality is equivalent to a Cocoon Data user either removing their access to secure content (shared with them) through SafeShare for Web, Windows, iOS or Android.

Supported roles and conditions

This API endpoint supports requests utilizing Cocoon Data user accounts with the following roles (as described in the Organisation Administrator's Guide):

Originator, Collaborator and Ad hoc - when this user is a collaborator on the item whose ID is specified by {itemId} in the URL.

The Cocoon Data Platform's resources available to one of these Cocoon Data users (above) is determined by the access token submitted in the header of requests to this endpoint.

Required headers

The appropriate access token as the Bearer token:

Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

Returns

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