API Reference Guide

About this guide

This guide describes each one of the Covata API endpoints, grouped according to the Covata Platform Service that exposes them.

Access Service

• Endpoints for all users
  • Authentication and authorisation endpoints
  • Access Service discovery endpoints
  • Key handling endpoints
  • File handling endpoints
  • Folder handling endpoints
  • Item handling endpoints (i.e. both files / Secure Objects and folders / collections)
  • User account handling endpoints
  • Organisation configuration and information retrieval endpoints
  • Classification endpoints
• Endpoints for Organisation administrators only
  • Organisation Administration dashboard endpoints
  • User whitelist endpoints
  • User group endpoints
  • Plan endpoints
  • Auditing/reporting endpoints
• Endpoints for SafeShare administrators
  • SafeShare Administration dashboard endpoints
  • Organisation administering endpoints
  • LDAP connection endpoints
  • Client application endpoints
  • SafeShare Administration configuration endpoints
  • Internationalisation (i18n) endpoints

Content Service

• Content Service discovery endpoints
• File content handling endpoints
• Folder content handling endpoints

For an overview on how to use these programming points throughout this client library, refer to the Developer's Guide.