Api Clients

An Api Client instance resource represents a single api client entity.

Resource Attributes

AttributeDescription
idA 23 to 26 characters long string that uniquely identifies this api client.
accountIdThe unique id of the account that created this api client.
nameAccount wide unique, URL friendly name of the api client.
friendlyNameHuman friendly name of the api client.
descriptionOptional. Api client description.
tagsOptional. Tags associated with this api client.
lockedif locked, entity cannot be modified, deleted.
dateCreatedThe date that this api client was created in ISO 8601 format.
dateModifiedThe date that this api client was modified in ISO 8601 format.
{
  "id": "_api_530976712669455460",
  "accountId": "_acc_530308970920181397",
  "name": "atm_data_reader",
  "friendlyName": "ATM Monitor Reader",
  "description": "This api client reads data from devices plugged into the atm-monitoring app.",
  "tags": [
    "test"
  ],
  "locked": false,
  "dateCreated": "2017-04-29T12:54:40.010Z",
  "dateModified": "2017-04-29T12:54:40.010Z"
}