Windows Platform Configurations via the REST API
This section provides the details of the REST APIs used to manage Windows platform configurations via WSO2 EMM Console:
Configuring Windows platform settings
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 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-windows-agent/services/configuration
Example: 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 | > 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."} | ||||||||||||||||||
Sample JSON Definition | { "type": "windows", "configuration": [ { "name": "notifierFrequency", "value": "100000", "contentType": "text" }, { "name": "windowsLicense", "value": "License Agreement", "contentType": "text" } ] }
|
Getting Windows platform configurations
Description | Get the Windows platform configuration details using this REST API. | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource Path | / | ||||||||||||
URL | /mdm-windows-agent/services/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-windows-agent/services/configuration
Example: curl -X GET -H "Content-Type: application/json" -H "Authorization: Bearer 4aa2a532e52b8b45c81cd815e0943538" -k -v https://localhost:9443/mdm-windows-agent/services/configuration | ||||||||||||
Sample output | > GET /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 < HTTP/1.1 200 OK < Date: Thu, 17 Mar 2016 12:47:07 GMT < Content-Type: application/json < Content-Length: 1924 < Server: WSO2 Carbon Server {"type":"windows","configuration":[{"name":"notifierFrequency","contentType":"text","value":"100000"},{"name":"windowsLicense","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": "windows", "configuration": [ { "name": "notifierFrequency", "contentType": "text", "value": "100000" }, { "name": "windowsLicense", "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" } ] }
|
Updating Windows platform configurations
Description | Update the Windows platform configurations using this REST API. | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource Path | / | ||||||||||||||||||
URL | /mdm-windows-agent/services/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-windows-agent/services/configuration
Example: curl -X PUT -H "Content-Type: application/json" -H "Authorization: Bearer 4aa2a532e52b8b45c81cd815e0943538" -d @'configurations.json'-k -v https://localhost:9443/mdm-windows-agent/services/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 4aa2a532e52b8b45c81cd815e0943538 > Content-Length: 2004 > Expect: 100-continue < HTTP/1.1 100 Continue < HTTP/1.1 200 OK < Date: Thu, 17 Mar 2016 12:53:10 GMT < Content-Type: application/json < Content-Length: 104 < Server: WSO2 Carbon Servert {"responseCode":"Accepted","responseMessage":"Android platform configuration updated successfully."} | ||||||||||||||||||
Sample JSON Definition | { "type": "windows", "configuration": [ { "name": "notifierFrequency", "value": "100000", "contentType": "text" }, { "name": "windowsLicense", "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", "contentType": "text" } ] }
|