Setting Up VPN on Android Devices

Description Set up VPN configurations on your Android devices remotely. It allows the device to access secured resources on the intranet of an organization.

Resource Path /vpn

URL /mdm-android-agent/operation/vpn

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-android-agent/operation/vpn

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

curl -X POST -H "Content-Type: application/json" -H "Authorization: Bearer 28cb30924cab975a076cee37fe3cabc" -d @'operation.json' -k -v https://localhost:9443/mdm-android-agent/operation/vpn

Sample output

> POST /mdm-android-agent/operation/vpn HTTP/1.1
> Host: localhost:9443
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Authorization: Bearer 428cb30924cab975a076cee37fe3cabc
> Content-Length: 185
< HTTP/1.1 201 Created
< Date: Wed, 27 Apr 2016 13:17:10 GMT
< Content-Length: 0
< Server: WSO2 Carbon Server

Sample JSON Definition

 {  
   "operation":{  
      "serverAddress":"abc.com",
      "serverPort":"1234",
      "sharedSecret":"wso2",
      "dnsServer":"1.1.1.1"
   },
   "deviceIDs":[  
      "2be702beaaf4ad34fc9e7f8da2b6b808c453fa72b",
      "2ec33430ad456713c633de75b2219376bac45de56"
   ]
}

Property Value	Description	Data Type
`operation`	This specifies the operation that is to be applied on the Android device.	-
`serverAddress`	Define the server address of the VPN.	String
`serverPort`	Define the server port of the VPN.	String
`sharedSecret`	Define the shared secret for the VPN connection. This is used for secure communication between the device and the WSO2 EMM server.	String
`dnsServer`	Define the DNS server URL. This field is optional.	String
`deviceIDs`	ID of the Android device. Multiple device IDs can be added by using comma separated values. For more information on retrieving the device ID, see Retrieving the ID of an Android device.	String