Unknown macro: {next_previous_link3}
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Next »

The WSO2 EMM dashboard provides an overview of the devices, so that the administrators are able to manage registered devices efficiently and effectively. This section provides the details of the REST APIs used to get the summarized details.

Getting device connectivity status overview

Description

Get the details of active, inactive, removed and total number of registered devices in WSO2 EMM.

Resource Path/device-count-overview
URL

/mdm-admin/dashboard/device-count-overview

HTTP MethodGET
Request/Response Formatapplication/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/dashboard/device-count-overview
  • 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.

Example:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c" -k -v https://localhost:9443/mdm-admin/dashboard/device-count-overview
 Sample output
> GET /mdm-admin/dashboard/devices-count-overview HTTP/1.1
> User-Agent: curl/7.38.0
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c
>
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Fri, 29 Apr 2016 11:32:49 GMT
< Content-Type: application/json
< Content-Length: 232
< Server: WSO2 Carbon Server
[{"context":"connectivity-status","data":[{"group":"total","label":"Total","count":5},{"group":"active","label":"Active","count":4},{"group":"inactive","label":"Inactive","count":0},{"group":"removed","label":"Removed","count":1}]}]
Sample JSON
Definition 
[  
   {  
      "context":"connectivity-status",
      "data":[  
         {  
            "group":"total",
            "label":"Total",
            "count":5
         },
         {  
            "group":"active",
            "label":"Active",
            "count":4
         },
         {  
            "group":"inactive",
            "label":"Inactive",
            "count":0
         },
         {  
            "group":"removed",
            "label":"Removed",
            "count":1
         }
      ]
   }
]
ParameterDefinition
context

Defines the attribute, to which the data is being populated. In this use case the attribute is connectivity-status.

dataDefines the data received.
group

The devices are grouped as follows:

  • Total: All the devices that have registered with WSO2 EMM.
  • active: The devices that are registered with WSO2 EMM and are actively communicating with the server.
  • inactive: The devices that are registered with WSO2 EMM but unable to actively communicate with the server.
  • removed: The devices that have unregistered from WSO2 EMM.
labelDefines the name of the grouped devices.
countThe number of devices in each category.

Getting policy non-compliant overview

Description

Get the number of devices that have not complied to a policy that was enforced on a device.

Resource Pathnon-compliant-device-counts-by-features
URL

/mdm-admin/dashboard/non-compliant-device-counts-by-features

HTTP MethodGET
Request/Response Formatapplication/json
cURL command
curl -v -L -G -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=<START>&length=<LENGTH>"
  • 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.
  • start - Provide the starting pagination index. Example 10
  • length- Provide how many policy details you require from the starting pagination index. For example if you require the non-compliant policy details from the 10th pagination index to the 15th, you must define 10 as the value for start and 5 as the value for length.

If you wish to get the device details within a predefined index range, you need to define both the start and length fields.
Example: https://localhost:9443/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=10&length=5"

There will be situations were you will not have any details in the specified index range. In such situation all the details of the devices that have not complied to a given policy is given.

Example:

curl -v -L -G -H "Content-Type: application/json" -H "Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c" -k -v https://localhost:9443/mdm-admin/dashboard/non-compliant-device-counts-by-features -d "start=10&length=5"
 Sample output
> GET /mdm-admin/dashboard/non-compliant-device-counts-by-features?start=0&length=5 HTTP/1.1
> User-Agent: curl/7.38.0
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer c148a833a9c3d30bb5197788eaad5541
>
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sat, 30 Apr 2016 06:55:54 GMT
< Content-Type: application/json
< Content-Length: 184
* Server WSO2 Carbon Server is not blacklisted
< Server: WSO2 Carbon Server
<
[{"context":"non-compliant-feature","data":[{"group":"PASSCODE_POLICY","label":"PASSCODE_POLICY","count":4},{"group":"WIFI","label":"WIFI","count":2}], "totalRecordCount":2}]
Sample JSON Output Definition 
[  
   {  
      "context":"non-compliant-feature",
      "data":[  
         {  
            "group":"PASSCODE_POLICY",
            "label":"PASSCODE_POLICY",
            "count":4
         },
         {  
            "group":"WIFI",
            "label":"WIFI",
            "count":2
         }
      ],
      "totalRecordCount":2
   }
]
ParameterDefinition
context

Defines the attribute, to which the data is being populated. In this use case the attribute is non-compliant-feature.

dataDefines the data received.
group

The devices are grouped according to the policy profile names.

labelDefines the name of the grouped devices.
countThe number of devices in each category.

Getting potential device vulnerability overview

Description

Get the number of unmonitored and non-compliant devices in WSO2 EMM.

Resource Path/device-counts-by-potential-vulnerabilities
URL

/mdm-admin/dashboard/device-counts-by-potential-vulnerabilities

HTTP MethodGET
Request/Response Formatapplication/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/dashboard/device-counts-by-potential-vulnerabilities
  • 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.

Example:

curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c" -k -v https://localhost:9443/mdm-admin/dashboard/device-counts-by-potential-vulnerabilities
 Sample output
> GET /mdm-admin/dashboard/device-counts-by-potential-vulnerabilities HTTP/1.1
> User-Agent: curl/7.38.0
> Host: localhost:9443
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 0ff0f5c5ef202f5abd933efef370a28c
< HTTP/1.1 200 OK
< Cache-Control: private
< Expires: Thu, 01 Jan 1970 05:30:00 IST
< Date: Sat, 30 Apr 2016 01:55:36 GMT
< Content-Type: application/json
< Content-Length: 164
< Server: WSO2 Carbon Server
[{"context":"potential-vulnerability","data":[{"group":"non-compliant","label":"Non-Compliant","count":5},{"group":"unmonitored","label":"Unmonitored","count":0}]}]
Sample JSON Output Definition 
[  
   {  
      "context":"potential-vulnerability",
      "data":[  
         {  
            "group":"non-compliant",
            "label":"Non-Compliant",
            "count":5
         },
         {  
            "group":"unmonitored",
            "label":"Unmonitored",
            "count":0
         }
      ]
   }
]
ParameterDefinition
context

Defines the attribute, to which the data is being populated. In this use case the attribute is potential-vulnerability.

dataDefines the data received.
group

The devices are grouped as follows:

  • non-compliant: The number of devices that have not complied to the policies enforced on the device by WSO2 EMM.
  • unmonitored: The number of devices that have no policy assigned on them.
labelDefines the name of the grouped devices.
countThe number of devices in each category.

  • No labels