Device Details via the Console
This section provides the details of the REST APIs used to retrieve device details via the EMM console:
Getting details of the devices supported via WSO2 EMM
Description | You are able to register Android, iOS and Windows devices with WSO2 EMM. Retrieve the device type details that can register with the EMM using the REST API command. | ||||||
---|---|---|---|---|---|---|---|
Resource Path | /types | ||||||
URL | /mdm-admin/devices/types | ||||||
HTTP Method | GET | ||||||
Request/Response Format | application/json | ||||||
cURL command | curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/devices/types
Example: curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices/types | ||||||
Sample output | > GET /mdm-admin/devices/types HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: */* > Content-Type: application/json > Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a < HTTP/1.1 200 OK < Cache-Control: private < Expires: Thu, 01 Jan 1970 05:30:00 IST < Date: Thu, 25 Feb 2016 06:14:53 GMT < Content-Type: application/json < Content-Length: 76 < Server: WSO2 Carbon Server [{"id":1,"name":"android"},{"id":2,"name":"windows"},{"id":33,"name":"ios"}] | ||||||
Sample JSON Output Definition | { "id":1, "name":"android" }
|
Getting details of registered devices
Description | Get the details of all the devices that are registered with WSO2 EMM. |
---|---|
Resource Path | / |
URL | /mdm-admin/devices/ |
HTTP Method | GET |
Request/Response Format | application/json |
cURL command | curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/devices/
Example: curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices/ Filter the device details using the query parameters given below:
Example: Getting all the device details that belong to the Android platform and are in the active state. curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices?type=android&status=active Example: Getting all the device details by filtering it using all the criteria given above. curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices?type=android&user=kim&role=admin&status=active&start=10&length=5&device-name=deviceAndroid&ownership=BYOD |
Sample output | > GET /mdm-admin/devices/ HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: */* > Content-Type: application/json > Authorization: Bearer 25ef46042442ed1ace0407e347a00116 < HTTP/1.1 200 OK < Cache-Control: private < Expires: Thu, 01 Jan 1970 05:30:00 IST < Date: Tue, 23 Feb 2016 08:46:30 GMT < Content-Type: application/json < Content-Length: 2760 < Server: WSO2 Carbon Server [{"id":1,"name":"iPad2,1","type":"ios","deviceIdentifier":"f409r4c55924rt4af9a44tts15y9d6cd56h1047d","enrolmentInfo":{"id":1,"dateOfEnrolment":1455530367905, "dateOfLastUpdate":1455530929113,"ownership":"BYOD","status":"ACTIVE","owner":"admin"},"properties":[{"name":"IMEI"},{"name":"IMSI"},{"name":"DEVICE_MODEL"}, {"name":"OS_VERSION"},{"name":"VENDOR"},{"name":"SERIAL"},{"name":"DEVICE_INFO","value":""},{"name":"UNLOCK_TOKEN","value":"REFUQQAABORWRVJTAAAABAAAAARUWVBF AAAABAAAAAJVVUlEAAAAEDok+/sZlEtnmLSmlqiTSNBITUNLAAAAKIkEgwM9aN+cM3jB2ihbjAjzscVFZF44KWMRiqbObXIk8Uc04cA6aZNXUkFQAAAABAAAAAFTQUxUAAAAFOd7vMcubI+lRqyOeXzIy2+y ahrVSVRFUgAAAAQAAMNQVVVJRAAAABARXsKxPWdMBIwUe8tBepAGQ0xBUwAAAAQAAAABV1JBUAAAAAQAAAADS1RZUAAAAAQAAAAAV1BLWQAAACiuli68139Nlyrlt+sQrex9DyMznbekgBG/YpU88TosPv3Z gTfv+W69VVVJRAAAABCEHODM8odI062wtfGbQCsLQ0xBUwAAAAQAAAACV1JBUAAAAAQAAAADS1RZUAAAAAQAAAABV1BLWQAAACgIv9owdjHQPXLmQCWst2KBRPcAqssL4ljyPuYTFC8HuJEZ845CISkdUEJL WQAAACDuRydL8f+7Ehpd+n2KpLy98aP61SP4Q7Dyi++QmHZ4X1VVSUQAAAAQG5dvfPt4R5qom+6kCjxTYkNMQVMAAAAEAAAAA1dSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAoqYP29LSIdJnt+dDk s2W284acgooKI6YGrEn94kpRE4OikBuqGsHsslVVSUQAAAAQO2SMlcsHRg2H9/ARYa0QpENMQVMAAAAEAAAABVdSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAowsLqZG2TjhAsCL3duV3Yi2FWmYQX P54Kkuf+ZnvYh0oVvpogW836j1VVSUQAAAAQkes/6WvtT+6WdD1y6/9UC0NMQVMAAAAEAAAABldSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAocMSprCTMCW8gRk9BB85RBkvc2ECYjAQE83yD0TfO bKRRYXIEcZc9vlVVSUQAAAAQ/td2Y08LRm+5cAdoofyh7kNMQVMAAAAEAAAAB1dSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAopDVoAk3kl+Cq/6+7A8DkRXYw1EYTfrXB0orsUd9c4dk5vXLo4W0V E1VVSUQAAAAQO7gkjb7QQca6TTEqEKGfq0NMQVMAAAAEAAAACFdSQVAAAAAEAAAAAUtUWVAAAAAEAAAAAFdQS1kAAAAg5j/ChdDxPsg+DWhAYzA5Db0MGWTccHDlfIS96tAk42lVVUlEAAAAEKvq0iYL90Ui qZL3AC2+pWBDTEFTAAAABAAAAAlXUkFQAAAABAAAAANLVFlQAAAABAAAAABXUEtZAAAAKB6zo5lA4+oS6cwHpjkUNHJcJF+ORWyl/KT7FaRN3pwg4xeBUoBGATxVVUlEAAAAEFLMFkufJkzFsvL+gc6L68BD TEFTAAAABAAAAApXUkFQAAAABAAAAANLVFlQAAAABAAAAABXUEtZAAAAKG+DmG4RPeuve/Q73R0Cet5wKcqM12QpXPgSTepbNd0U3rAFkSxjAXhVVUlEAAAAEPOZe4L+7UsXuWkHSC+ncwtDTEFTAAAABAAA AAtXUkFQAAAABAAAAAFLVFlQAAAABAAAAABXUEtZAAAAIAR5oPQTHAlhaFgt0WQVpiKuEiGiNw810CA4LqF+sR4TU0lHTgAAABTCz+wpGk5UMQiOyYf7BMRT+P9dgg\u003d\u003d"},{"name":"MDM_TOKEN","value":"XCKB3DbVBGCzJGdi3ynhAvIiYLDn5j4b1tDufA98miA\u003d"},{"name":"DEVICE_NAME","value":""},{"name":"APNS_PUSH_TOKEN","value":"45f6d60f6394cf129d7e56bb176d8a34bfecb120345b2b1719d4d9df2b4fd8d2"},{"name":"PRODUCT","value":"iPad"},{"name":"MAGIC_TOKEN","value":"EF9A5A51-F6DC-4D3C-BAF4-139E4C50BAEA"},{"name":"ICCID","value":""},{"name":"LATITUDE","value":""},{"name":"CHALLENGE_TOKEN","value":""},{"name":"VERSION","value":"12F69"},{"name":"IMEI","value":""},{"name":"MAC_ADDRESS","value":""},{"name":"LONGITUDE","value":""},{"name":"SERIAL","value":"DN6G9LG1DFHW"}]}] |
Sample JSON Output Definition | To know more on iOS specific device details, see the iOS device information property definition. |
Getting details of a device
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 | 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}
Example: 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 | > 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"}]}] | ||||||||||||||||||||||||||||
Sample JSON Definition | { "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.
To know more on iOS specific device details, see the iOS device information property definition. |
Getting details of devices registered to a user
Description | Get the details of the devices registered to a specific user. |
---|---|
Resource Path | /user/{user}/{tenantDomain} |
URL | /mdm-admin/devices/user/{user}/{tenantDomain} |
HTTP Method | GET |
Request/Response Format | application/json |
cURL command | curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/devices/user/{user}/{tenantDomain}
Example: curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices/user/admin/cabon.super |
Sample output | > GET /mdm-admin/devices/user/admin/carbon.super HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: */* > Content-Type: application/json > Authorization: Bearer 7eac81ad075883838ab88596922f4433 < HTTP/1.1 200 OK < Cache-Control: private < Expires: Thu, 01 Jan 1970 05:30:00 IST < Date: Tue, 23 Feb 2016 09:32:25 GMT < Content-Type: application/json < Content-Length: 2760 < Server: WSO2 Carbon Server [{"id":1,"name":"iPad2,1","type":"ios","deviceIdentifier":"d607b9c22764ef3af9a33ddd13d0d6cd58a6546a","enrolmentInfo":{"id":1,"dateOfEnrolment":1455530367905,"dateOfLastUpdate":1455530929113, "ownership":"BYOD","status":"ACTIVE","owner":"admin"},"properties":[{"name":"IMEI"},{"name":"IMSI"},{"name":"DEVICE_MODEL"},{"name":"OS_VERSION"},{"name":"VENDOR"},{"name":"SERIAL"}, {"name":"DEVICE_INFO","value":""},{"name":"UNLOCK_TOKEN","value":"REFUQQAABORWRVJTAAAABAAAAARUWVBFAAAABAAAAAJVVUlEAAAAEDok+/sZlEtnmLSmlqiTSNBITUNLAAAAKIkEgwM9aN+cM3jB2ihbjAjzscVFZF4 4KWMRiqbObXIk8Uc04cA6aZNXUkFQAAAABAAAAAFTQUxUAAAAFOd7vMcubI+lRqyOeXzIy2+yahrVSVRFUgAAAAQAAMNQVVVJRAAAABARXsKxPWdMBIwUe8tBepAGQ0xBUwAAAAQAAAABV1JBUAAAAAQAAAADS1RZUAAAAAQAAAAAV1BLWQAA ACiuli68139Nlyrlt+sQrex9DyMznbekgBG/YpU88TosPv3ZgTfv+W69VVVJRAAAABCEHODM8odI062wtfGbQCsLQ0xBUwAAAAQAAAACV1JBUAAAAAQAAAADS1RZUAAAAAQAAAABV1BLWQAAACgIv9owdjHQPXLmQCWst2KBRPcAqssL4ljyP uYTFC8HuJEZ845CISkdUEJLWQAAACDuRydL8f+7Ehpd+n2KpLy98aP61SP4Q7Dyi++QmHZ4X1VVSUQAAAAQG5dvfPt4R5qom+6kCjxTYkNMQVMAAAAEAAAAA1dSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAoqYP29LSIdJnt+dDks2 W284acgooKI6YGrEn94kpRE4OikBuqGsHsslVVSUQAAAAQO2SMlcsHRg2H9/ARYa0QpENMQVMAAAAEAAAABVdSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAowsLqZG2TjhAsCL3duV3Yi2FWmYQXP54Kkuf+ZnvYh0oVvpogW836j1V VSUQAAAAQkes/6WvtT+6WdD1y6/9UC0NMQVMAAAAEAAAABldSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAocMSprCTMCW8gRk9BB85RBkvc2ECYjAQE83yD0TfObKRRYXIEcZc9vlVVSUQAAAAQ/td2Y08LRm+5cAdoofyh7kNMQVMA AAAEAAAAB1dSQVAAAAAEAAAAA0tUWVAAAAAEAAAAAFdQS1kAAAAopDVoAk3kl+Cq/6+7A8DkRXYw1EYTfrXB0orsUd9c4dk5vXLo4W0VE1VVSUQAAAAQO7gkjb7QQca6TTEqEKGfq0NMQVMAAAAEAAAACFdSQVAAAAAEAAAAAUtUWVAAAAAEA AAAAFdQS1kAAAAg5j/ChdDxPsg+DWhAYzA5Db0MGWTccHDlfIS96tAk42lVVUlEAAAAEKvq0iYL90UiqZL3AC2+pWBDTEFTAAAABAAAAAlXUkFQAAAABAAAAANLVFlQAAAABAAAAABXUEtZAAAAKB6zo5lA4+oS6cwHpjkUNHJcJF+ORWyl/K T7FaRN3pwg4xeBUoBGATxVVUlEAAAAEFLMFkufJkzFsvL+gc6L68BDTEFTAAAABAAAAApXUkFQAAAABAAAAANLVFlQAAAABAAAAABXUEtZAAAAKG+DmG4RPeuve/Q73R0Cet5wKcqM12QpXPgSTepbNd0U3rAFkSxjAXhVVUlEAAAAEPOZe4L +7UsXuWkHSC+ncwtDTEFTAAAABAAAAAtXUkFQAAAABAAAAAFLVFlQAAAABAAAAABXUEtZAAAAIAR5oPQTHAlhaFgt0WQVpiKuEiGiNw810CA4LqF+sR4TU0lHTgAAABTCz+wpGk5UMQiOyYf7BMRT+P9dgg\u003d\u003d"},{"name":"MDM_TOKEN","value":"XCKB3DbVBGCzJGdi3ynhAvIiYLDn5j4b1tDufA98miA\u003d"},{"name":"DEVICE_NAME","value":""},{"name":"APNS_PUSH_TOKEN","value":"45f6d60f6394cf129d7e56bb176d8a34bfecb120345b2b1719d4d9df2b4fd8d2"},{"name":"PRODUCT","value":"iPad"},{"name":"MAGIC_TOKEN","value":"EF9A5A51-F6DC-4D3C-BAF4-139E4C50BAEA"},{"name":"ICCID","value":""},{"name":"LATITUDE","value":""},{"name":"CHALLENGE_TOKEN","value":""},{"name":"VERSION","value":"12F69"},{"name":"IMEI","value":""},{"name":"MAC_ADDRESS","value":""},{"name":"LONGITUDE","value":""},{"name":"SERIAL","value":"DN6G9LG1DFHW"}]}] |
Sample JSON Output Definition | To know more on iOS specific device details, see the iOS device information property definition. |
Getting the device count
Description | Get the number of devices that are registered with WSO2 EMM. |
---|---|
Resource Path | /count |
URL | /mdm-admin/devices/count |
HTTP Method | GET |
Request/Response Format | application/json |
cURL command | curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/devices/count
Example: curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -k -v https://localhost:9443/mdm-admin/devices/count |
Sample output | > GET /mdm-admin/devices/count HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: */* > Content-Type: application/json > Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a > < HTTP/1.1 200 OK < Cache-Control: private < Expires: Thu, 01 Jan 1970 05:30:00 IST < Date: Tue, 23 Feb 2016 09:35:05 GMT < Content-Type: application/json < Content-Length: 1 < Server: WSO2 Carbon Server < * Connection #0 to host localhost left intact 20 |
Sample JSON Output Definition | Provides the number of devices registered with WSO2 EMM at the time of running the REST API command as an integer value. Example: As per the above sample output there are 20 device registered with the EMM. |