API Reference Guide

​

About this Guide

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

​

Access Service

Authentication and authorization

• <access-service>/api/oauth/token
• <access-service>/api/v1/auth/token/revoke

Discovery Service

• <access-service>/api/v1

Secure Object handling

• <access-service>/api/v1/keys
• <access-service>/api/v1/keys/{keyId}
• <access-service>/api/v1/objects
• <access-service>/api/v1/objects/{objectId}
• <access-service>/api/v1/objects/{objectId}/enable
• <access-service>/api/v1/objects/{objectId}/keys
• <access-service>/api/v1/objects/{objectId}/keys/view
• <access-service>/api/v1/objects/bulk
• <access-service>/api/v1/permissions/sets

Collection handling

• <access-service>/api/v1/collections
• <access-service>/api/v1/collections/{collectionId}
• <access-service>/api/v1/collections/{collectionId}/collections

Item handling (i.e. both Secure Objects and collections)

• <access-service>/api/v1/collaborations/items/{itemId}
• <access-service>/api/v1/items
• <access-service>/api/v1/items/{itemId}
• <access-service>/api/v1/items/{itemId}/ancestry
• <access-service>/api/v1/items/{itemId}/history
• <access-service>/api/v1/items/{itemId}/unshare
• <access-service>/api/v1/items/delta
• <access-service>/api/v1/items/status

Covata Administration dashboard handling

• <access-service>/api/v1/dashboard/clients
• <access-service>/api/v1/dashboard/groups
• <access-service>/api/v1/dashboard/items
• <access-service>/api/v1/dashboard/items/activity
• <access-service>/api/v1/dashboard/items/extensions
• <access-service>/api/v1/dashboard/items/shared
• <access-service>/api/v1/dashboard/ldap
• <access-service>/api/v1/dashboard/plans
• <access-service>/api/v1/dashboard/plans/usage
• <access-service>/api/v1/dashboard/users
• <access-service>/api/v1/dashboard/users/activity
• <access-service>/api/v1/dashboard/users/roles
• <access-service>/api/v1/dashboard/whitelist

User handling

• <access-service>/api/v1/users
• <access-service>/api/v1/users/{userid}
• <access-service>/api/v1/users/{userId}/enable
• <access-service>/api/v1/users/{userId}/expire
• <access-service>/api/v1/users/{userId}/items/count
• <access-service>/api/v1/users/{userId}/unlock
• <access-service>/api/v1/users/bulk
• <access-service>/api/v1/users/import
• <access-service>/api/v1/users/me
• <access-service>/api/v1/users/me/applications/approvals
• <access-service>/api/v1/users/me/applications/approvals/{approvalId}
• <access-service>/api/v1/users/me/contacts
• <access-service>/api/v1/users/me/contacts/{contactId}
• <access-service>/api/v1/users/me/items/count
• <access-service>/api/v1/users/me/notifications/email

User whitelist handling

• <access-service>/api/v1/userwhitelist
• <access-service>/api/v1/userwhitelist/{userwhitelistId}
• <access-service>/api/v1/userwhitelist/bulk
• <access-service>/api/v1/userwhitelist/check

LDAP handling

• <access-service>/api/v1/ldap
• <access-service>/api/v1/ldap/{ldapconnectionId}
• <access-service>/api/v1/ldap/{ldapconnectionId}/enable
• <access-service>/api/v1/ldap/verifyconnection

Label handling

• <access-service>/api/v1/labels
• <access-service>/api/v1/labels/{labelId}
• <access-service>/api/v1/labels/{labelId}/priority

Group handling

• <access-service>/api/v1/groups
• <access-service>/api/v1/groups/{groupId}
• <access-service>/api/v1/groups/{groupId}/labels
• <access-service>/api/v1/groups/{groupId}/users

Plan handling

• <access-service>/api/v1/plans
• <access-service>/api/v1/plans/{planId}

Client Application handling

• <access-service>/api/v1/clientapps
• <access-service>/api/v1/clientapps/{clientInfoId}
• <access-service>/api/v1/clientapps/{clientInfoId}/enable

Audit/report handling

• <access-service>/api/v1/audit
• <access-service>/api/v1/audit/exportReport

Configuration handling

• <access-service>/api/v1/config
• <access-service>/api/v1/config/server
• <access-service>/api/v1/config/server/{configId}

Theme handling

• <access-service>/api/v1/config/theme/adminHelpUrl
• <access-service>/api/v1/config/theme/applicationName
• <access-service>/api/v1/config/theme/companyName
• <access-service>/api/v1/config/theme/copyright
• <access-service>/api/v1/config/theme/emailHeaderDividerColor
• <access-service>/api/v1/config/theme/headerPrimaryColor
• <access-service>/api/v1/config/theme/headerTextColor
• <access-service>/api/v1/config/theme/img/{imageLocationToOverride}
• <access-service>/api/v1/config/theme/legalUrl
• <access-service>/api/v1/config/theme/supportLink
• <access-service>/api/v1/config/theme/versionUrl
• <access-service>/api/v1/config/theme/webappHelpUrl
• <access-service>/api/v1/config/theme/…

Internationalization (I18n)

• <access-service>/api/v1/i18n/adminpreference
• <access-service>/api/v1/i18n/bundles
• <access-service>/api/v1/i18n/bundles/{localeCode}
• <access-service>/api/v1/i18n/{localeCode}/delete
• <access-service>/api/v1/i18n/{localeCode}/download
• <access-service>/api/v1/i18n/{localeCode}/reset
• <access-service>/api/v1/i18n/localedetails
• <access-service>/api/v1/i18n/reload

​

Content Service

Discovery Service

• <content-service>/api/v1

Secure Object handling

• <content-service>/api/v1/objects/{objectId}/contents
• <content-service>/api/v1/objects/{objectId}/view

Collection handling

• <content-service>/api/v1/collections/{collectionId}/contents

Item handling (i.e. both Secure Objects and collections)

• <content-service>/api/v1/items/transfer

User handling

• <content-service>/api/v1/users
• <content-service>/api/v1/users/{userid}/contents
• <content-service>/api/v1/users/me

Plan handling

• <content-service>/api/v1/plans/usage
• <content-service>/api/v1/plans/usage/{userid}

For an overview on how to use these programming points throughout this client library, refer to the Getting Started Guide.