Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Excerpt
Description

Configure the Windows platform settings using this REST API. For more information on configuring the Windows platform settings via WSO2 EMM console, see Windows Platform Configurations.

Resource Path/
URL/mdm-windows-agent/services/configuration
HTTP MethodPOST
Request/Response Formatapplication/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-windows-agent/services/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 4aa2a532e52b8b45c81cd815e0943538" -d @'configurations.json' -k -v https://localhost:9443/mdm-windows-agent/services/configuration
 Sample output
Code Block
> POST /mdm-windows-agent/services/configuration HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 4aa2a532e52b8b45c81cd815e0943538
> Content-Length: 242
< HTTP/1.1 201 Created
< Date: Thu, 17 Mar 2016 12:11:19 GMT
< Content-Type: application/json
< Content-Length: 97
< Server: WSO2 Carbon Server
{"responseCode":"Created","responseMessage":"Windows platform configuration saved successfully."}
Anchor
sampleUpdatePlatform
sampleUpdatePlatform
Sample JSON
Definition 
Code Block
{
  "type": "androidwindows",
  "configuration": [
    {
      "name": "notifierFrequency",
      "value": "100000",
      "contentType": "text"
    },
    {
      "name": "windowsLicense",
      "value": "License Agreement",
      "contentType": "text"
    }
  ]
} 
PropertyDescriptionValue
typeDefine the mobile platform.String
configurationDefines the configuration properties.String
nameProvide the configuration property name.String
contentTypeWhen passing the configuration details to the EMM registry the content type must be defined.String
value

Provide a value for the respective configuration property.

  • notifierFrequency: Provide the notification frequency in milliseconds.

  • windowsLicense: Provide the content for the license agreement that a user must accept when enrolling an Windows device with WSO2 EMM.

String