Hide menu
Overview

Account management API allows to manage your CAD Exchanger Cloud account from your application.

Users

User's account in CAD Exchanger Cloud Service is organized as users collection. Every member of collection has next fields:

FieldTypeDescription
idread-onlyString

Unique user id

emailread-onlyString

User's email.

fullNameString

User's full name specified on registration.

rootFolderread-onlyString

User's root folder id.

createdAtread-onlyString

Timestamp when member has been created.

updatedAtread-onlyString

Timestamp when member has been updated.

Root folder

After registration every user has own root folder named "Home", which is used for storing all user's data. Root folder has no parent and cannot be shared with another users.

Authentication and Scopes

Account management API requires to use of OAuth2 bearer token.

  • HTTP GET requests require the user:read scope.
  • HTTP POST requests require the user:write scope.
  • HTTP DELETE requests require the user:write scope.

See OAuth documentation for more information about authentication

Errors

If request failed the response body contains an errors property with array of errors.

For example, if request authorization token doesn't have user:read scope, the HTTP 403 (Forbidden) response will be return with next payload:

{
"errors": [{
"message": "no-access",
"attributes": { "scope": "insufficient" }
}]
}