API Reference

Accounts

An Account instance resource represents a single account entity.

A system account can be master or sub account depending on its location in the account hierarchy.

Sub accounts are created under a master or another sub account. Unlike master accounts, sub accounts have ownerId attribute in their resource definition. Owner account's administrator can access to all resources (e.g. devices, users, etc..) of their sub accounts for administrative purposes.

🚧

Rule

Master accounts cannot be created using Admin Services API. You must use Connio portal in order to create your master account and get a user api key. Sub accounts on the other hand can be created using Admin Services API.

Resource Attributes

AttributeDescription
idA 23 to 26 characters long string that uniquely identifies this account.
nameA user selected name (as specified at the signup) that uniquely identifies this account.
friendlyNameDisplay name of the account.
ownerIdOptional. Id of the owner account, if any.
planThe plan type of the account. Either trial or one of the paid plans.
statusThe status of this account. Usually open, but can be closed and suspended.
organizationOptional. Details of the organization that this account is related to.
descriptionOptional. Account description.
tagsOptional. The list of the tags associated with the account.
balanceThe current balance of the account in US dollars, if paid plan.
lockedLocked account cannot be deleted, modified, new sub elements (e.g. sub accounts, devices, etc..) cannot be added, or existing sub elements cannot be removed; but its sub elements can be modified.
dateCreatedThe date that this account was created in ISO 8601 format.
dateModifiedThe date that this account was last modified in ISO 8601 format.

Below is a fully populated Account instance resource.

{
  "id": "_acc_833847694816627075",
  "name": "Inbiza",
  "friendlyName": "Inbiza Technology Solutions",
  "plan": {
    "type": "trial",
    "expiresAt": "2017-12-31T23:59:59Z"
  },
  "status": "open",
  "organization": {
    "name": "Inbiza Technology Solutions Ltd.",
    "websiteUrl": "http://www.inbiza.com",
    "imageUrl": "http://www.inbiza.com/images/logo.jpg"
  },
  "description": "Inbiza is a technology consulting company specialized in Cloud computing, embedded systems, and IoT solutions.",
  "tags": ["canada", "system integrator"],
  "balance": {
    "amount": 0
  },
  "locked": false,
  "dateCreated": "2017-02-24T11:46:31.293Z",
  "dateModified": "2017-04-24T01:13:21.346Z"
}

Api key credentials allow Connio to infer requester's identity. For example if you are using your account's admin user's api key credentials, you can simply use _this_ placeholder to refer to your account. On the other hand, if you want to operate on a sub account, you need to specify a reference (i.e id or name) explicitly.

Sub Account Brief View

When an owner account query for its sub accounts, the following response object returned from the system. Response object provides a brief view of the sub accounts instead of providing all account attributes. You should query the sub account using its id in order to access its full view.

Response object consists of the following attributes:

AttributeDescription
idA 23 character string that uniquely identifies this account.
nameA user selected name (as specified at the signup) that uniquely identifies this account.
ownerIdId of the owner account.
planThe plan type of the account. Either trial or one of the paid plans.
statusThe status of this account. Usually open, but can be closed and suspended.
balanceThe balance of the account if paid plan.
lockedRestricted or fully accessible.
dateCreatedThe date that this account was created in ISO 8601 format.