Windows API Guide
Check out the latest APIs!
Click here to check out the latest APIs.
The following sections illustrate the Windows device operation APIs that are used in WSO2 EMM:
Adding a Device Lock on Windows Devices
Description | Add a screen lock on Windows devices. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Resource Path | /lock-devices | ||||||||
URL | /api/device-mgt/windows/v1.0/services/windows/lock-devices | ||||||||
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>/api/device-mgt/windows/v1.0/services/windows/lock-devices
Example: curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'windows-operation.json' -k -v https://localhost:9443/api/device-mgt/windows/v1.0/services/windows/lock-devices | ||||||||
Sample JSON Definition | [ "urn:uuid:FAEFB2D5-1771-5446-A635-797AFC474895", "urn:uuid:FEDCB4T2-1345-2857-F274-263BES386554" ]
|
Disenrolling Windows Devices
Description | Remove selected Windows devices from WSO2 EMM. | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Resource Path | /disenroll | ||||||||||||
URL | /api/device-mgt/windows/v1.0/services/windows/disenroll | ||||||||||||
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>/api/device-mgt/windows/v1.0/services/windows/disenroll
Example: curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'windows-operation.json' -k -v https://localhost:9443/api/device-mgt/windows/v1.0/services/windows/disenroll | ||||||||||||
Sample JSON Definition | [ "urn:uuid:FAEFB2D5-1771-5446-A635-797AFC474895", "urn:uuid:FEDCB4T2-1345-2857-F274-263BES386554" ]
|
Resetting the Lock of Windows Devices
Description | Reset the lock of Windows devices. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Resource Path | /lock-reset | ||||||||
URL | /api/device-mgt/windows/v1.0/services/windows/lock-reset | ||||||||
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>/api/device-mgt/windows/v1.0/services/windows/lock-reset
Example: curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'windows-operation.json' -k -v https://localhost:9443/api/device-mgt/windows/v1.0/services/windows/lock-reset | ||||||||
Sample JSON Definition | [ "urn:uuid:FAEFB2D5-1771-5446-A635-797AFC474895", "urn:uuid:FEDCB4T2-1345-2857-F274-263BES386554" ]
|
Ringing Windows Devices
Description | Ring Windows devices. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Resource Path | /ring-device | ||||||||
URL | /api/device-mgt/windows/v1.0/services/windows/ring-device | ||||||||
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>/api/device-mgt/windows/v1.0/services/windows/ring-device
Example: curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'windows-operation.json' -k -v https://localhost:9443/api/device-mgt/windows/v1.0/services/windows/ring-device | ||||||||
Sample JSON Definition | [ "urn:uuid:FAEFB2D5-1771-5446-A635-797AFC474895", "urn:uuid:FEDCB4T2-1345-2857-F274-263BES386554" ]
|
Wiping Information off Windows Devices
Description | Wipe information off Windows devices. | ||||||||
---|---|---|---|---|---|---|---|---|---|
Resource Path | /wipe-data | ||||||||
URL | /api/device-mgt/windows/v1.0/services/windows/wipe-data | ||||||||
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>/api/device-mgt/windows/v1.0/services/windows/wipe-data
Example: curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 33392fb365b3ac693b405b565ddc8a3a" -d @'windows-operation.json' -k -v https://localhost:9443/api/device-mgt/windows/v1.0/services/windows/wipe-data | ||||||||
Sample JSON Definition | [ "urn:uuid:FAEFB2D5-1771-5446-A635-797AFC474895", "urn:uuid:FEDCB4T2-1345-2857-F274-263BES386554" ]
|