This documentation is for WSO2 Enterprise Mobility Manager 2.2.0. View documentation for the latest release.
Windows API Guide - Enterprise Mobility Manager 2.2.0 - WSO2 Documentation
||
Skip to end of metadata
Go to start of metadata

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

DescriptionAdd a screen lock on Windows devices.
Resource Path/lock-devices
URL/api/device-mgt/windows/v1.0/services/windows/lock-devices
HTTP MethodPOST
Request/Response Formatapplication/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
  • For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
  • Define the path to the JSON file, which lists the devices that this operation is applied on, as the  <JSON_PAYLOAD>  value.
  • 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 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"
]

Property value

Description

Data
type 
Example

device_id

ID of the Windows device. Multiple device IDs can be added by using comma separated values. 
For more information on retrieving the device ID, see Retrieving a device ID.

String

urn:uuid:FAEFB2D5-1771-
5446-A635-797AFC474895

Disenrolling Windows Devices

DescriptionRemove selected Windows devices from WSO2 EMM.
Resource Path/disenroll
URL/api/device-mgt/windows/v1.0/services/windows/disenroll
HTTP MethodPOST
Request/Response Formatapplication/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
  • For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
  • Define the path to the JSON file, which lists the devices that this operation is applied on, as the <JSON_PAYLOAD> value.
  • 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 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"
]

Property Value

Description

Required

Default
Value 

Data
Type

Example

device id

ID of the Windows device. Multiple device IDs can be added by using comma separated values. 
For more information on retrieving the device ID, see Retrieving a device ID.

Yes

N/A

String

urn:uuid:FAEFB2D5-
1771-5446-A635-797AFC474895

Resetting the Lock of Windows Devices

DescriptionReset the lock of Windows devices.
Resource Path/lock-reset
URL/api/device-mgt/windows/v1.0/services/windows/lock-reset
HTTP MethodPOST
Request/Response Formatapplication/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
  • For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
  • Define the path to the JSON file, which lists the devices that this operation is applied on, as the  <JSON_PAYLOAD>  value.
  • 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 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"
]

Property value

Description

Data
type 
Example

device_id

ID of the Windows device. Multiple device IDs can be added by using comma separated values. 
For more information on retrieving the device ID, see Retrieving a device ID.

String

urn:uuid:FAEFB2D5-1771-
5446-A635-797AFC474895

Ringing Windows Devices

DescriptionRing Windows devices.
Resource Path/ring-device
URL/api/device-mgt/windows/v1.0/services/windows/ring-device
HTTP MethodPOST
Request/Response Formatapplication/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
  • For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
  • Define the path to the JSON file, which lists the devices that this operation is applied on, as the  <JSON_PAYLOAD>  value.
  • 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 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"
]

Property value

Description

Data
type 
Example

device_id

ID of the Windows device. Multiple device IDs can be added by using comma separated values. 
For more information on retrieving the device ID, see Retrieving a device ID.

String

urn:uuid:FAEFB2D5-1771-5446
-A635-797AFC474895

Wiping Information off Windows Devices

DescriptionWipe information off Windows devices.
Resource Path/wipe-data
URL/api/device-mgt/windows/v1.0/services/windows/wipe-data
HTTP MethodPOST
Request/Response Formatapplication/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
  • For more information on how to generate the EMM API token, see Generating the OAuth 2.0 Access Token.
  • Define the path to the JSON file, which lists the devices that this operation is applied on, as the  <JSON_PAYLOAD>  value.
  • 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 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"
]

Property value

Description

Data
type 
Example

device_id

ID of the Windows device. Multiple device IDs can be added by using comma separated values. 
For more information on retrieving the device ID, see Retrieving a device ID.

String

urn:uuid:FAEFB2D5-1771-
5446-A635-797AFC474895

  • No labels