Get the Devices for a user

Contents

Get the Devices this User is attached to (APPROVED or PENDING_APPROVAL).

Endpoint URL: {service.device.url} received in EndpointFetching

Request Syntax


GET /v1/user/{userId}



Request Headers

Parameter Description Required
Authorization Authorization token in the form "Bearer {token}."

Value of type: string
true


Request Path Parameters

Parameter Description Required
userId Value of type: string true


Request Query Parameters

Parameter Description Required
limit Number of records per page.

Value of type: integer
false
pageToken Token of page you want to retrieve.

Value of type: string
false


200 Response

successful operation

Response Payload

Description Required
Array of type: Device false


Example

Sample request to get the devices attached to the user.

Request


GET device/v1/user/{userId} HTTP/1.1
Host: Endpoint-URL
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJ
Content-Type: application/json

Response


[
  {
      "deviceId": "string",
      "modelId": "0",
      "name": "User's My Cloud Home",
      "mac": "string",
      "type": "monarch",
      "cloudConnected": true,
      "createdOn": "DateandTime",
      "attachedStatus": "APPROVED",
      "configuration": {
          "wisb": "string",
          "wiri": "string"
      },
      "firmware": {
          "wiri": "string"
      },
      "network": {
          "localIpAddress": "string",
          "externalIpAddress": "string",
          "internalDNSName": "string",
          "connectionType": 3,
          "httpPort": 0,
          "portForwardPort": -1,
          "tunnelId": "string",
          "externalURI": "string",
          "internalURI": "string",
          "internalURL": "string",
          "proxyURL": "string"
      },
      "sendOTANotification": true,
      "lang": "en_US",
      "ownerAccess": true
  }
]

Have question about this section?