URL structure

1 https://access-service.xy-company.com/api/v1/organisations/{organisationId}

where {organisationId} is the ID of an organisation.

Supported methods and overview

DELETE - removes an organisation (specified by organisationId) configured on the Cocoon Data Platform (available to SafeShare administrators only) on the proviso that this organisation has an existing request for its removal (made by another SafeShare administrator).

Note: This method takes no parameters.

Detailed description

This API endpoint removes an organisation (specified by organisationId) configured on the Cocoon Data Platform by a SafeShare administrator.

For a request to this endpoint to succeed, a previous call to <access-service>/api/v1/organisations/{organisationId}/removalRequest (i.e. to initiate a request to remove this organisation) must have already been made by another SafeShare administrator whose access token was submitted in the request to that API endpoint.

Tip: To determine if an organisation has an existing request for its removal, use the <access-service>/api/v1/organisations API endpoint to retrieve information about organisations configured on the Cocoon Data Platform and if the required organisation's organisationRemovalRequest member is not null and contains sub-members, then the organisation has an existing request for its removal.

Supported roles and conditions

This API endpoint supports the following Cocoon Data user roles (as described in the SafeShare Administrator's Guide):

SafeShare administrator - when this user is a different SafeShare administrator to the one who initiated the request to remove this organisation.

The Cocoon Data Platform's resources available to a Cocoon Data user meeting the criteria 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.