Android Platform Configurations via the REST API

This section provides the details of the REST APIs used to manage Android platform configurations via WSO2 EMM Console:

Configuring Android platform settings

Description	Configure the Android platform settings using this REST API. For more information on configuring the Android platform settings via WSO2 EMM console, see Android Platform Configurations.
Resource Path	`/`
URL	`/mdm-android-agent/configuration/`
HTTP Method	`POST`
Request/Response Format	`application/json`
cURL command	curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-android-agent/configuration/ For more information on how to generate the `<EMM_API_TOKEN>`, see Generating the EMM API Token. Define the path to the JSON file, which includes the required properties to update the platform configurations as the `<JSON_PAYLOAD>` value. For more information, see the Sample JSON Definition. 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 POST -H "Content-Type: application/json" -H "Authorization: Bearer f4c0c1b2b4ace7040132682139d51f74" -d @'configurations.json'-k -v https://localhost:9443/mdm-android-agent/configuration/
Sample output	> POST /mdm-android-agent/configuration/ HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: / > Content-Type: application/json > Authorization: Bearer 6218f325e398e429f80d73cbc290c8da > Content-Length: 337 < HTTP/1.1 201 Created < Date: Sat, 12 Mar 2016 08:27:50 GMT < Content-Type: application/json < Content-Length: 97 < Server: WSO2 Carbon Server {"responseCode":"Created","responseMessage":"Android platform configuration saved successfully."
Sample JSON Definition

Getting Android platform configurations

Description

Get the Android platform configuration details using this REST API.

Resource Path /

URL /mdm-android-agent/configuration/

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-android-agent/configuration/

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 4dc71df3bbc55988f5fbda9b2c3135ae" -k -v https://localhost:9443/mdm-android-agent/configuration/

Sample output

> GET /mdm-android-agent/configuration/ HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 4dc71df3bbc55988f5fbda9b2c3135ae
< HTTP/1.1 200 OK
< Date: Sat, 12 Mar 2016 13:18:50 GMT
< Content-Type: application/json
< Content-Length: 1978
< Server: WSO2 Carbon Server
{"type":"android","configuration":[{"name":"notifierType","contentType":"text","value":"1"},{"name":"notifierFrequency","contentType":"text","value":"100000"},{"name":"androidEula","contentType":"text","value":"\u003cp\u003eThis End User License Agreement (\"Agreement\") is a legal agreement between you (\"You\") and WSO2, Inc., regarding the enrollment of Your personal mobile device (\"Device\") in SoR\u0027s mobile device management program, and the loading to and removal from Your Device and Your use of certain applications and any associated software and user documentation, whether provided in \"online\" or electronic format, used in connection with the operation of or provision of services to WSO2, Inc., BY SELECTING \"I ACCEPT\" DURING INSTALLATION, YOU ARE ENROLLING YOUR DEVICE, AND THEREBY AUTHORIZING SOR OR ITS AGENTS TO INSTALL, UPDATE AND REMOVE THE APPS FROM YOUR DEVICE AS DESCRIBED IN THIS AGREEMENT. YOU ARE ALSO EXPLICITLY ACKNOWLEDGING AND AGREEING THAT (1) THIS IS A BINDING CONTRACT AND (2) YOU HAVE READ AND AGREE TO THE TERMS OF THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT ENROLL YOUR DEVICE AND DO NOT PROCEED ANY FURTHER. You agree that: (1) You understand and agree to be bound by the terms and conditions contained in this Agreement, and (2) You are at least 21 years old and have the legal capacity to enter into this Agreement as defined by the laws of Your jurisdiction. SoR shall have the right, without prior notice, to terminate or suspend (i) this Agreement, (ii) the enrollment of Your Device, or (iii) the functioning of the Apps in the event of a violation of this Agreement or the cessation of Your relationship with SoR (including termination of Your employment if You are an employee or expiration or termination of Your applicable franchise or supply agreement if You are a franchisee of or supplier to the WSO2 WSO2, Inc., system). SoR expressly reserves all rights not expressly granted herein.\u003c/p\u003e"}]}

Sample JSON Output
Definition

{
  "type": "android",
  "configuration": [
    {
      "name": "notifierType",
      "contentType": "text",
      "value": "1"
    },
    {
      "name": "notifierFrequency",
      "contentType": "text",
      "value": "100000"
    },
    {
      "name": "androidEula",
      "contentType": "text",
      "value": "\u003cp\u003eThis End User License Agreement (\"Agreement\") is a legal agreement between you (\"You\") and WSO2, Inc., regarding the enrollment of Your personal mobile device (\"Device\") in SoR\u0027s mobile device management program, and the loading to and removal from Your Device and Your use of certain applications and any associated software and user documentation, whether provided in \"online\" or electronic format, used in connection with the operation of or provision of services to WSO2, Inc., BY SELECTING \"I ACCEPT\" DURING INSTALLATION, YOU ARE ENROLLING YOUR DEVICE, AND THEREBY AUTHORIZING SOR OR ITS AGENTS TO INSTALL, UPDATE AND REMOVE THE APPS FROM YOUR DEVICE AS DESCRIBED IN THIS AGREEMENT. YOU ARE ALSO EXPLICITLY ACKNOWLEDGING AND AGREEING THAT (1) THIS IS A BINDING CONTRACT AND (2) YOU HAVE READ AND AGREE TO THE TERMS OF THIS AGREEMENT. IF YOU DO NOT ACCEPT THESE TERMS, DO NOT ENROLL YOUR DEVICE AND DO NOT PROCEED ANY FURTHER. You agree that: (1) You understand and agree to be bound by the terms and conditions contained in this Agreement, and (2) You are at least 21 years old and have the legal capacity to enter into this Agreement as defined by the laws of Your jurisdiction. SoR shall have the right, without prior notice, to terminate or suspend (i) this Agreement, (ii) the enrollment of Your Device, or (iii) the functioning of the Apps in the event of a violation of this Agreement or the cessation of Your relationship with SoR (including termination of Your employment if You are an employee or expiration or termination of Your applicable franchise or supply agreement if You are a franchisee of or supplier to the WSO2 WSO2, Inc., system). SoR expressly reserves all rights not expressly granted herein.\u003c/p\u003e"
    }
  ]
}

Property Value

Description

type Defines the mobile platform.

configuration Defines the configuration properties.

name Many properties are needed to configure the Android platform therefore the name field is used to identify each property.

contentType When passing the configuration details to the EMM registry the content type must be defined.

value

This field gives the details of the value assigned to the respective configuration property.

notifierType: The values assigned to the configuration property having the name notifierType is as follows:

Value	Description
1	The Android Platform is configured to communicate via Local Polling. The device will contact the EMM server periodically. For more information on the notifier type and the notifier frequency, see Android Notification Methods.
2	The Android Platform is configured to communicate via GCM. GCM will send a notification to the device when there are pending operations available for a specific device. If GCM has been selected as the notifier type, register with Google Cloud Messaging (GCM).

notifierFrequency: The notification frequency is given in milliseconds.
androidEula: Provides the license agreement that a user accepts when enrolling an Android device with WSO2 EMM.

If you configured the Android platform to communicate via GCM, the following values will be assigned to the properties mentioned below:

gcmAPIKey: The API key that you received after registering with Google Cloud Messaging (GCM).
gcmSenderId: This refers to the project IDs.

Updating Android platform configurations

Description	Update the Android platform configurations using this REST API.
Resource Path	`/`
URL	`/mdm-android-agent/configuration/`
HTTP Method	`PUT`
Request/Response Format	`application/json`
cURL command	curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer <EMM_API_TOKEN>" -d @'<JSON_PAYLOAD>' -k -v https://<EMM_HOST>:<EMM_HTTPS_PORT>/mdm-android-agent/configuration/ For more information on how to generate the `<EMM_API_TOKEN>`, see Generating the EMM API Token. Define the path to the JSON file, which includes the required properties to update the platform configurations as the `<JSON_PAYLOAD>` value. For more information, see the Sample JSON Definition. 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 PUT -H "Content-Type: application/json" -H "Authorization: Bearer bc725ce276165c8aa96f4f245dc90aa0" -d @'configurations.json'-k -v https://localhost:9443/mdm-android-agent/configuration/
Sample output	> PUT /mdm-android-agent/configuration/ HTTP/1.1 > Host: localhost:9443 > User-Agent: curl/7.43.0 > Accept: / > Content-Type: application/json > Authorization: Bearer bc725ce276165c8aa96f4f245dc90aa0 < HTTP/1.1 200 OK < Date: Sat, 12 Mar 2016 14:21:04 GMT < Content-Type: application/json < Content-Length: 104 < Server: WSO2 Carbon Server {"responseCode":"Accepted","responseMessage":"Android platform configuration has updated successfully."}
Sample JSON Definition