Exchange ActiveSync (EAS)
List All ActiveSync Devices
This API returns a list of ActiveSync unique device IDs (uuid) that use ActiveSync to connect to the enterprise. Devices are grouped as follows in the return list: Registered Allowed, Registered Blocked, Unregistered Allowed, Unregistered Blocked, and Wiped.
An administrator may wish to block an ActiveSync device to prevent it from connecting to the enterprise (i.e., get email). If a device is blocked, any previously synchronized email is removed. Use the allow feature to permit a device to connect to the enterprise which was previously blocked.
Example:
https://<Ivanti EPMM>/api/v1/eas/devices
|
URI: |
All ActiveSync devices are returned. |
|
|
Http Method: |
GET |
|
|
Format: |
xml, json |
|
|
|
|
|
|
Response Status Code: |
|
|
|
‘404 – No Data Found’ |
There is no data. |
|
|
‘200 – OK’ |
Data is present and the response is returned. |
|
|
Response: |
|
|
|
<easWebServiceReponse> |
|
|
|
<messages> |
|
|
|
<message>212 Device(s) returned</message> |
Status message. Lists the number of devices found, or that no devices were found. |
|
|
</messages> |
|
|
|
<registeredAllowedDevices> |
|
|
|
<registeredAllowedDevice> |
All the child elements of the <registeredAllowedDevice> element are also in the <registeredBlockedDevice>, <unregisteredAllowedDevice>, <unregisteredBlockedDevice>, and <wipedDevice> elements. |
|
|
<uuid>hdgd-e93c-49b1-88d6-222f54132445</uuid> |
ActiveSync unique identifier for the device. |
|
|
<domain>exchdomain.com</domain> |
The Exchange ActiveSync domain of the device. |
|
|
<deviceId>Appl87025CNUA4S</deviceId> |
ActiveSync device identifier. |
|
|
<mailboxId>jdoe113</mailboxId> |
ActiveSync mailbox ID for the device. |
|
|
<userName>jdoe113</username> |
ActiveSync username associated with the device. |
|
|
<phoneNumber>6505551212</phoneNumber> |
Phone number associated with the device. |
|
|
<model>iPhone</model> |
Device model as recorded by the ActiveSync server. |
|
|
<platform>iOS</platform> |
Device operating system as recorded by the ActiveSync server. |
|
|
<platformCode>11</platformCode> |
Device operating system code as recorded by te ActiveSync server. |
|
|
<status>Registered</status> |
Ivanti status for the device. |
|
|
<activeSyncStatus>Allowed</activeSyncStatus> |
ActiveSync status for the device. |
|
|
<firstSyncTime>1326179585000</firstSyncTime> |
The timestamp for the first time the device synchronized ActiveSync data. This time field is expressed in Unix Epoch Time, which is the number of milliseconds since January 1, 1970. |
|
|
<lastSyncTime>1326180768000</lastSyncTime> |
The timestamp for te last time the device synchronized ActiveSync data. This time field is expressed in Unix Epoch Time, which is the number of milliseconds since January 1, 1970. |
|
|
<miDeviceUuid>6f72cabb-1d8b-4965-aa8e-a355deab8222</miDeviceUuid> |
Ivanti unique identifier for the device. |
|
|
<actionSource>EXCHANGE</actionSource> |
|
|
|
</registeredAllowedDevice> |
ActiveSync unique identifier for a registered device with Allowed status. |
|
|
</registeredAllowedDevices> |
A list of ActiveSync unique identifiers for registered devices with Allowed status. |
|
|
<registeredBlockedDevices> |
A list of ActiveSync unique identifiers for registered devices with Blocked status. |
|
|
<registeredBlockedDevice> |
|
|
|
<uuid>hgdgd-fsg-4wfsb1-dgdg-dgfdg</uuid> |
ActiveSync unique identifier for a registered device with Blocked status. |
|
|
</ registeredBlockedDevice > |
|
|
|
</ registeredBlockedDevices> |
|
|
|
<unregisteredAllowedDevices> |
A list of ActiveSync unique identifiers for unregistered devices with Allowed status. |
|
|
<unregisteredAllowedDevice> |
|
|
|
<uuid>8herw5345d711cdc-e93c-dfg-hgdf-hssgfd</uuid> |
ActiveSync unique identifier for an unregistered device with Allowed status. |
|
|
</ unregisteredAllowedDevice > |
|
|
|
</ unregisteredAllowedDevices> |
|
|
|
<unregisteredBlockedDevices> |
A list of ActiveSync unique identifiers for unregistered devices with Blocked status. |
|
|
<unregisteredBlockedDevice> |
|
|
|
<uuid>34gdrtger-4err-gd-88d6-2fes</uuid> |
ActiveSync unique identifier for an unregistered device with Blocked status. |
|
|
</ unregisteredBlockedDevice > |
|
|
|
</ unregisteredBlockedDevices> |
|
|
|
<wipedDevices> |
A list of ActiveSync unique identifiers for devices that have been wiped via ActiveSync wipe. |
|
|
< wipedDevice > |
|
|
|
<uuid>sersdfsc-e93c-49b1-88d6-sg2wefwef</uuid> |
ActiveSync unique identifier for a wiped device. |
|
|
</ wipedDevice > |
|
|
|
</ wipedDevices > |
|
|
|
</easWebServiceReponse> |
|
|
|
|
|
|
Device Details for ActiveSync
This API returns a variety of details for devices using ActiveSync to connect to the Enterprise. Details ranging from the first time such device was synced to the ActiveSync version are returned.
Example:
https://<Ivanti EPMM>/api/v1/eas/devices/ee8198d9-5d79-4961-94c4-e21bf04b2467
|
URI: |
Device details of the input Exchange ActiveSync device uuid is returned |
|
Http Method: |
GET |
|
Format: |
xml, json |
|
Request: |
|
|
EASDeviceUuid |
Required. Exchange ActiveSync device uuid. |
|
|
|
|
Response Status Code: |
|
|
‘404 – No Data Found’ |
There is no data. |
|
‘200 – OK’ |
Data is present and the response is returned. |
|
Response: |
|
|
<easDevice> |
|
|
<uuid>f5def24e-4380-4565-bd2f-8cf002fd64cd</uuid> |
|
|
<details> |
A series of key/value pairs determined by ActiveSync. |
|
<entry> |
|
|
<key>ActionSource</key> |
EXCHANGE('e', "Exchange"): Initial state set by the Exchange server. AUTOBLOCK('a', "Auto"): state set by Auto Block action POLICY('p', "Policy"): state set by policy enforcement MANUAL('m', "Manual"): state set manually by administrator UNKNOWN('u', "Unknown") |
|
<value>Exchange</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>LastPingHeartbeat</key> |
|
|
<value>600</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceID</key> |
|
|
<value>Appl9C0180RF75J</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>FirstSyncTime</key> |
|
|
<value>7/6/2010 11:29:33 AM</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DevicePolicyApplicationStatus</key> |
|
|
<value>AppliedInFull</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>LastSyncAttemptTime</key> |
|
|
<value>7/7/2010 12:14:52 PM</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>NumberOfFoldersSynced</key> |
|
|
<value>2</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceType</key> |
|
|
<value>iPod</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceModel</key> |
|
|
<value>iPod</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceUserAgent</key> |
|
|
<value>Apple-iPod/705.18</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>Status</key> |
|
|
<value>DeviceOk</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>Guid</key> |
|
|
<value>61a8a847-8e3b-4496-8da6-587b845b77cf</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceAccessState</key> |
|
|
<value>Allowed</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceEnableOutboundSMS</key> |
|
|
<value>False</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>Identity</key> |
|
|
<value>newyork.Ivanti.com/Users/Sang Truong/ExchangeActiveSyncDevices/iPod§Appl9C0180RF75J</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceAccessStateReason</key> |
|
|
<value>Individual</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DevicePolicyApplied</key> |
|
|
<value>Default</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>LastPolicyUpdateTime</key> |
|
|
<value>7/6/2010 11:29:34 AM</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>IsRemoteWipeSupported</key> |
|
|
<value>True</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>LastSuccessSync</key> |
|
|
<value>7/7/2010 12:14:52 PM</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>RecoveryPassword</key> |
|
|
<value>********</value> |
|
|
</entry> |
|
|
<entry> |
|
|
<key>DeviceActiveSyncVersion</key> |
|
|
<value>12.1</value> |
|
|
</entry> |
|
|
</details> |
|
|
</easDevice> |
|
Request Action on ActiveSync Device
This API requests status changes to devices using ActiveSync to connect to the Enterprise.
Example:
https://<Ivanti EPMM>/api/v1/eas/devices?action=BLOCK_DEVICE&uuids=ee8198d9-5d79-4961-94c4-e21bf04b2467&uuids=fe816c9-4c68-3850-83b3-d10ae93a1356
|
URI: |
The requested action will be applied on the device. |
|
Http Method: |
PUT |
|
Format: |
xml, json |
|
Request: |
|
|
uuids |
Required. One or more Exchange ActiveSync device uuids. |
|
action |
Required. Valid Actions are: BLOCK_DEVICE: Block the device from accessing ActiveSync server. REINSTATE_DEVICE: Allow the device to access ActiveSync server. WIPE: Wipe the device, which returns its settings to the factory defaults. |
|
Response Status Code: |
|
|
‘404 – No Data Found’ |
There is no data. |
|
‘200 – OK’ |
Data is present and the response is returned. |
|
Response: |
|
|
<easWebServiceResponse> |
|
|
<messages> |
|
|
<message> |
|
|
1 device(s) modified to BLOCK_DEVICE status |
Status message. Displays action taken on EAS device. |
|
</ message > |
|
|
</messages> |
|
|
</easWebServiceResponse> |
|