Chapter 6. Devices API

6.1. List Devices

6.1.1. Description

Get a list of the devices which have autheticated against the platform.

6.1.2. Endpoint

  • uri - /box/srv/1.1/admin/device/list
  • method - POST

6.1.3. Request Body

{}

6.1.4. Response Body

6.1.4.1. Success

{
  "status": "ok",
  "count": <total device count>,
  "list" : [
    {
      "guid": "<device_global_unique_id>",
      "fields": {
        "cuid": "<id_assigned_by_device>",
        "name": "<Friendly_name_of_device>",
        "disabled": true|false, /* Is this device currently blocked from logging in */
        "blacklisted": true|false /* Should data be purged from apps the next time the device authenticates */
      }
    },
    ...
  ]
}

6.1.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}

6.2. Read Device

6.2.1. Description

Read details of a specific device based on its id.

6.2.2. Endpoint

  • uri - /box/srv/1.1/admin/device/read
  • method - POST

6.2.3. Request Body

{
  "cuid": "<id_assigned_by_device>"
}

6.2.4. Response Body

6.2.4.1. Success

{
  "status": "ok",
  "guid": "<global_unique_id>",
  "fields": {
    "cuid": "<id_assigned_by_device>",
    "name": "<Friendly_name_of_device>",
    "disabled": true|false, /* Is this device currently blocked from logging in */
    "blacklisted": true|false /* Should data be purged from apps the next time the device authenticates */
  }
}

6.2.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}

6.3. Update Device

6.3.1. Description

Update details of a specific device based on its guid.

6.3.2. Endpoint

  • uri - /box/srv/1.1/admin/device/update
  • method - POST

6.3.3. Request Body

{
  "cuid": "<id_assigned_by_device>",
  "name": "<Friendly_name_of_device>",  /* Optional */
  "disabled": true|false   /* Optional - DEFAULT=false - Is this device currently blocked from logging in */
  "blacklisted": true|false /* Optional - DEFAULT=false - Should data be purged from apps the next time the device authenticates */
}

6.3.4. Response Body

6.3.4.1. Success

{
  "status": "ok",
  "guid": "<global_unique_id>",
  "fields": {
    "cuid": "<id_assigned_by_device>",
    "name": "<Friendly_name_of_device>",
    "disabled": true|false, /* Is this device currently blocked from logging in */
    "blacklisted": true|false /* Should data be purged from apps the next time the device authenticates */
  }
}

6.3.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}

6.4. List Apps

6.4.1. Description

Return a list of the apps which have autheticated from the specified device id.

6.4.2. Endpoint

  • uri - /box/srv/1.1/admin/device/listapps
  • method - POST

6.4.3. Request Body

{
  "cuid": "<id_assigned_by_device>"
}

6.4.4. Response Body

6.4.4.1. Success

{
  "status": "ok",
  "count": <total apps count>,
  "list" : [
    {
      "guid": <unique app guid>,
      "fields" : {
        "name" : <app name>,
        "description" : <app description>,
      }
    },
    ...
  ]
}

6.4.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}

6.5. List Users

6.5.1. Description

Return a list of the user ids which have autheticated from the specified device id.

6.5.2. Endpoint

  • uri - /box/srv/1.1/admin/device/listusers
  • method - POST

6.5.3. Request Body

{
  "cuid": "<id_assigned_by_device>"
}

6.5.4. Response Body

6.5.4.1. Success

{
  "status": "ok",
  "count": <total users count>,
  "list" : [
    {
      "guid": <unique user guid>,
      "fields" : {
        "userId" : <unique user id>,
        "email" : <user email>
      }
    },
    ...
  ]
}

6.5.4.2. Error

{
  "status": "error",
  "message": "<error_message>"
}