<access-service>/api/v1/items/{itemId}/unshare

URL structure

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

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

Supported methods and overview

• PUT - used to remove all collaborators from a Secure Object or collection (i.e. item), based on the item's ID.

Note: This method takes no parameters.

Detailed description

This API endpoint removes all collaborators from either a Secure Object or a collection, using 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 a collection, then all collaborators will also be removed from all items contained within this collection; that is, the removal of collaborators from a collection cascades down through the hierarchy of items contained within this collection.

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 on an item they own.

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.