Page Comparison

Excerpt

Description Get the device details of a specific device via the REST API.

Resource Path /name/{name}/{tenatDomain}

URL /mdm-admin/devices/name/{name}/{tenatDomain}

HTTP Method GET

Request/Response Format application/json

cURL command

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/devices/name/{name}/{tenatDomain}

For more information on how to generate the <EMM_API_TOKEN>, see Generating the EMM API Token.
By default, <EMM_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
By default, <EMM_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.
Provide the {name} of the device. If you are unsure of the name of the device, run the REST API command to get all the device registered with EMM and search for name in the given output. Example: iPad2,1
Provide the tenant domain as the value for {tenantDomain}. The default tenant domain of WSO2 EMM is carbon.super. For more information on adding a tenant, see Managing Tenants.

Example:

Code Block
curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices/name/iPad2,1/carbon.super

Sample output

Code Block

> GET /mdm-admin/devices/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 962dbc66fac79437b6fa09bcc1252773
> 
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 04 Mar 2016 10:05:08 GMT
< Content-Type: application/json
< Content-Length: 1200
< Server: WSO2 Carbon Server
< 
* Connection #0 to host localhost left intact
[{"id":1,"name":"titan_umts","type":"android","description":"titan_umts","deviceIdentifier":"359298055243973","enrolmentInfo":{"id":1,"dateOfEnrolment":1456895832161,"dateOfLastUpdate":1456895832161,"ownership":"BYOD","status":"ACTIVE","owner":"admin"},"properties":[{"name":"IMEI","value":"359298055243973"},{"name":"IMSI","value":"413025702363929"},{"name":"DEVICE_MODEL","value":"XT1064"},{"name":"OS_VERSION","value":"5.0.2"},{"name":"VENDOR","value":"motorola"},{"name":"SERIAL"},{"name":"DEVICE_INFO","value":"[{\"name\":\"IMEI\",\"value\":\"359298055243973\"},{\"name\":\"IMSI\",\"value\":\"413025702363929\"},{\"name\":\"DEVICE_MODEL\",\"value\":\"XT1064\"},{\"name\":\"VENDOR\",\"value\":\"motorola\"},{\"name\":\"OS_VERSION\",\"value\":\"5.0.2\"},{\"name\":\"DEVICE_NAME\",\"value\":\"titan_umts\"},{\"name\":\"BATTERY_LEVEL\",\"value\":\"59\"},{\"name\":\"INTERNAL_TOTAL_MEMORY\",\"value\":\"5.51\"},{\"name\":\"INTERNAL_AVAILABLE_MEMORY\",\"value\":\"0.61\"},{\"name\":\"EXTERNAL_TOTAL_MEMORY\",\"value\":\"0.0\"},{\"name\":\"EXTERNAL_AVAILABLE_MEMORY\",\"value\":\"0.0\"},{\"name\":\"OPERATOR\",\"value\":\"Dialog\"}]"},{"name":"DEVICE_NAME","value":"titan_umts"},{"name":"GCM_TOKEN"}]}]

Anchor

	sample
	sample

Sample JSON
Definition

Code Block

{  
   "id":1,
   "name":"titan_umts",
   "type":"android",
   "description":"titan_umts",
   "deviceIdentifier":"359298055243973",
   "enrolmentInfo":{  
      "id":1,
      "dateOfEnrolment":1456895832161,
      "dateOfLastUpdate":1456895832161,
      "ownership":"BYOD",
      "status":"ACTIVE",
      "owner":"admin"
   },
   "properties":[  
      {  
         "name":"IMEI",
         "value":"359298055243973"
      },
      {  
         "name":"IMSI",
         "value":"413025702363929"
      },
      {  
         "name":"DEVICE_MODEL",
         "value":"XT1064"
      },
      {  
         "name":"OS_VERSION",
         "value":"5.0.2"
      },
      {  
         "name":"VENDOR",
         "value":"motorola"
      },
      {  
         "name":"SERIAL"
      },
      {  
         "name":"DEVICE_INFO",
         "value":"[{\"name\":\"IMEI\",\"value\":\"359298055243973\"},{\"name\":\"IMSI\",\"value\":\"413025702363929\"},{\"name\":\"DEVICE_MODEL\",\"value\":\"XT1064\"},{\"name\":\"VENDOR\",\"value\":\"motorola\"},{\"name\":\"OS_VERSION\",\"value\":\"5.0.2\"},{\"name\":\"DEVICE_NAME\",\"value\":\"titan_umts\"},{\"name\":\"BATTERY_LEVEL\",\"value\":\"59\"},{\"name\":\"INTERNAL_TOTAL_MEMORY\",\"value\":\"5.51\"},{\"name\":\"INTERNAL_AVAILABLE_MEMORY\",\"value\":\"0.61\"},{\"name\":\"EXTERNAL_TOTAL_MEMORY\",\"value\":\"0.0\"},{\"name\":\"EXTERNAL_AVAILABLE_MEMORY\",\"value\":\"0.0\"},{\"name\":\"OPERATOR\",\"value\":\"Dialog\"}]"
      },
      {  
         "name":"DEVICE_NAME",
         "value":"titan_umts"
      },
      {  
         "name":"GCM_TOKEN"
      }
   ]
}

The details given below, explains the Android device information.

Parameter Definition

id The ID of the device.

name The name of the device.

type

The mobile platform of the device. Example: android, ios or windows

description A description of the registered device.

deviceIdentifier

The device ID.

enrolmentInfo

Provide the device enrollment information.

id

The device ID.

dateOfEnrolment

The date the device was enrolled.

Info
The date is given in the Epoch time format.

dateOfLastUpdate

The date the device was last updated.

Info
The date is given in the Epoch time format.

ownership

Provides the ownership details. The ownership type can be any of the values given below:

BYOD - Bring your own device (BYOD).
COPE - Corporate owned personally enabled (COPE).

status

The status of the device. A device can be in the active or inactive state.

owner

Provides the device owners name name.

properties

The properties provide the following information:

IMEI:
IMSI:
DEVICE_MODEL:
OS_VERSION:
VENDOR:
SERIAL:
DEVICE_INFO:
GCM_TOKEN:
DEVICE_NAME:

To know more on iOS specific device details, see the iOS device information property definition.

Versions Compared

Old Version 11

New Version 12

Key