<access-service>/api/v1/organisations/{orgId}/items/transfer

URL structure

https://access-service.xy-company.com/api/v1/organisations/{orgId}/items/transfer

where {orgId} is the ID of an organisation.

Supported methods and overview

• POST - transfers the ownership of all file objects and folders from one Covata user to another Covata user.

Detailed description

This API endpoint transfers the ownership of all files/Secure Objects and folders/collections (in which these files are contained) from one Covata user to another Covata user, within the organisation specified by the {orgId} of the request's URL.

Notes:

• When using Organisation Administration to transfer item ownership from one Covata user to another, this process must be done as part of removing a user account from an organisation.
• However, when using the Covata API, transferring item ownership from a Covata user can be accomplished without having to remove this user from the organisation.

Supported roles and conditions

This API endpoint supports requests utilising Covata user accounts with the following roles (as described in the Organisation Administrator's Guide) and conditions:

• Organisation administrator - when this user is a member of the organisation specified by the {orgId} of the request's URL.

The Covata Platform's resources available to Covata users meeting this criteria 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:

• Authorisation: Bearer eyJhbGciOiJSUzI1NiJ9.eyJleHAiOjE0NjcwMTY2NjYsInVzZXJfbmFtZSI6ImFsZXgub...

The following header is required if the body of the request has a JSON object:

• Content-Type: application/json

Required parameters

The following required parameters must be sent in the body of the POST request, as individual members of a JSON object:

• from - The ID of a Covata user (with the Originator role), whose items will be transferred to another Covata user.
• to - The ID of another Covata user (with the Originator role) to whom these items will be transferred.
  Example (request):

  {
    "from": "749419842687528960",
    "to": "750613175405441024"
  }

Optional parameters

The following optional parameter can also be sent in the body of the POST request, as an individual member of the JSON object that includes the Required parameters above:

• folderName - The name of a new folder that will be created at the root location of the Covata user (represented by to above) to whom the complete hierarchy of items (belonging to the user represented by from above) will be transferred.
  Note: If this parameter is omitted, then a new folder (like this) will automatically be created with a default name consisting of the email address of the Covata user (represented by from) followed by an underscore, followed by the current date.

• deleteUser - A boolean value that indicates whether (true) or not (false) the Covata user specified in the from field above, whose items are being transfered to another user, will be removed from the organisation.

  
  Example (request):

  {
    "from": "749419842687528960",
    "to": "750613175405441024",
    "folderName": "Alex's items",
    "deleteUser": true
  }

Returns

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