Synchronous Execution

To perform synchronization in synchronous mode, use the synchronize custom operation of the Tenant APS resource whose APS ID you prepared, as explained below.

After running this operation, full synchronization is performed for the Microsoft account that belongs to the Tenant APS resource.

Important: Synchronization is a custom operation. The user whose key and secret you use to access the APS REST API must have http://www.parallels.com/Office365/Tenant and GET in its list of allowed operations.

HTTP Request

GET https://BRAND_DOMAIN/aps/2/resources/APS_ID_OF_TENANT_RESOURCE/synchronize

HTTP Response

{
  "domains": [SYNCHRONIZED_DOMAINS],
  "users": [SYNCHRONIZED_USERS],
  "AllUpdatesSucceeded": STATUS
}

This response contains the following data:

• SYNCHRONIZED_DOMAINS: This is a list of synchronized domains.
• SYNCHRONIZED_USERS: This is a list of synchronized users.
• STATUS: This is synchronization status (true for success or false for failure).

Example

HTTP Request

GET https://example.com/aps/2/resources/6fcff2c9-de5c-4eb3-b2b7-d5722cc29338/synchronize

HTTP Response

{
  "domains": [],
  "users": [
    {
      "objectName": "johnmonk@example.onmicrosoft.com",
      "operationCode": 1,
      "success": true,
      "comment": null
    }
  ],
  "AllUpdatesSucceeded": true
}