Page Comparison

Excerpt

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

Code Block
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 the 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:

Code Block
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

Code Block

> 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."

Anchor

	sampleUpdatePlatform
	sampleUpdatePlatform

Sample JSON
Definition

Localtabgroup

Localtab

title	Local polling

Code Block

{
  "type": "android",
  "configuration": [
    {
      "name": "notifierType",
      "value": "1",
      "contentType": "text"
    },
    {
      "name": "notifierFrequency",
      "value": "100000",
      "contentType": "text"
    },
    {
      "name": "androidEula",
      "value": "License Agreement",
      "contentType": "text"
    }
  ]
}

Property Description Value

type Define the mobile platform. String

configuration Defines the configuration properties. String

name Provide the configuration property name. String

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

value

Provide a value for the respective configuration property.

notifierType: If you wish to configure the Android platform to communicate via local polling, assign 1 as the value.
Info
The device will contact the EMM server periodically. For more information on the notifier type and the notifier frequency, see Android Notification Methods.
notifierFrequency: Provide the notification frequency in milliseconds.
androidEula: Provide the content for the license agreement you wish the user to that a user must accept when enrolling an Android device with WSO2 EMM.

String

Localtab

title	GCM

Code Block

{
  "type": "android",
  "configuration": [
    {
      "name": "notifierType",
      "value": "1",
      "contentType": "text"
    },
    {
      "name": "notifierFrequency",
      "value": "100000",
      "contentType": "text"
    },
    {
      "name": "androidEula",
      "value": "License Agreement",
      "contentType": "text"
    },
    {
      "name": "gcmSenderId",
      "value": "458263461614",
      "contentType": "text"
    }
  ]
}

Property Description Value

type Define the mobile platform. String

configuration Defines the configuration properties. String

name Provide the configuration property name. String

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

value

Provide a value for the respective configuration property.

notifierType: If you wish to configure the Android platform to communicate via GCM, assign 2 as the value.

Info
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: Provide the notification frequency in milliseconds.
androidEula: Provide the content for the license agreement that a user must accept when enrolling an Android device with WSO2 EMM.

String

Versions Compared

Old Version 9

New Version 10

Key