Main Topics

Here is a list of the main topic pages in this guide:

[detail level 123]

▼Getting Started Guide
Authentication and authorization
Creating files and folders
Retrieving information about items from the Covata Platform
Sharing items
▼API Reference Guide
►Authentication and authorization endpoints
<access-service>/api/oauth/authorize
<access-service>/api/oauth/token
►Access Service discovery endpoints
<access-service>/api/v1
►File handling endpoints
<access-service>/api/v1/keys
<access-service>/api/v1/keys/{keyId}
<access-service>/api/v1/organisations/{orgGroupId}/objects
<access-service>/api/v1/objects
<access-service>/api/v1/objects/{objectId}
<access-service>/api/v1/organisations/{orgGroupId}/objects/{objectId}/enable
<access-service>/api/v1/objects/{objectId}/keys
<access-service>/api/v1/objects/{objectId}/keys/view
<access-service>/api/v1/objects/bulk
►Folder handling endpoints
<access-service>/api/v1/collections
<access-service>/api/v1/collections/{collectionId}
<access-service>/api/v1/collections/{collectionId}/collections
►Item handling endpoints
<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
<access-service>/api/v1/organisations/{orgId}/items/transfer
<access-service>/api/v1/permissions/sets
►Safe Share Administration dashboard endpoints
<access-service>/api/v1/dashboard/clients
<access-service>/api/v1/dashboard/ldap
<access-service>/api/v1/dashboard/organisations
<access-service>/api/v1/dashboard/quotas
<access-service>/api/v1/dashboard/users/activity
►Organization Administration dashboard endpoints
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items/storage
<access-service>/api/v1/organisations/{orgGroupId}/statistics/items/extensions
<access-service>/api/v1/organisations/{orgGroupId}/statistics/plans
<access-service>/api/v1/organisations/{orgGroupId}/statistics/users
►User account handling endpoints
<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 endpoints
<access-service>/api/v1/userwhitelist
<access-service>/api/v1/userwhitelist/{userwhitelistId}
<access-service>/api/v1/userwhitelist/bulk
<access-service>/api/v1/userwhitelist/check
►LDAP connection endpoints
<access-service>/api/v1/ldap
<access-service>/api/v1/ldap/{ldapconnectionId}
<access-service>/api/v1/ldap/{ldapconnectionId}/enable
<access-service>/api/v1/ldap/verifyconnection
►Classification endpoints
<access-service>/api/v1/organisations/{orgId}/labels
<access-service>/api/v1/organisations/{orgId}/labels/{labelId}
<access-service>/api/v1/organisations/{orgId}/labels/{labelId}/priority
►User group endpoints
<access-service>/api/v1/organisations/{orgId}/groups
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}/labels
<access-service>/api/v1/organisations/{orgId}/groups/{groupId}/users
►Plan endpoints
<access-service>/api/v1/plans
<access-service>/api/v1/plans/{planId}
►Client application endpoints
<access-service>/api/v1/clientapps
<access-service>/api/v1/clientapps/{clientInfoId}
<access-service>/api/v1/clientapps/{clientInfoId}/enable
►Auditing/reporting endpoints
<access-service>/api/v1/audit
<access-service>/api/v1/audit/exportReport
►Safe Share Administration configuration endpoints
<access-service>/api/v1/config
<access-service>/api/v1/config/server
<access-service>/api/v1/config/server/{configId}
<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/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/...
Organization Administration configuration endpoints
►Internationalization (i18n) endpoints
<access-service>/api/v1/i18n/adminpreference
<access-service>/api/v1/i18n/bundles
<access-service>/api/v1/i18n/bundles/{localeCode}
<access-service>/api/v1/i18n/bundles/{localeCode}/delete
<access-service>/api/v1/i18n/bundles/{localeCode}/download
<access-service>/api/v1/i18n/bundles/{localeCode}/reset
<access-service>/api/v1/i18n/localedetails
<access-service>/api/v1/i18n/reload
►Content Service discovery endpoints
<content-service>/api/v1
►File content handling endpoints
<content-service>/api/v1/objects/{objectId}/contents
<content-service>/api/v1/objects/{objectId}/view
►Folder content handling endpoints
<content-service>/api/v1/collections/{collectionId}/contents
►User content handling endpoints
<content-service>/api/v1/users
<content-service>/api/v1/users/{userid}/contents
<content-service>/api/v1/users/me
►Plan content endpoints
<content-service>/api/v1/plans/usage
<content-service>/api/v1/plans/usage/{userid}
Getting Support
Important notice