Phase 2 synchronizes Exchange calendar resources (rooms) and Dynamic Distribution Lists (DDLs) into Zoom.
The following must be prepared before running the Exchange Sync Tool:
- PowerShell 7 or later installed.
- ExchangeOnlineManagement PowerShell module installed.
- An Exchange Online app registration for certificate-based authentication.
- A Zoom Server-to-Server OAuth app with the required permissions.
- A Zoom calendar service already connected to Exchange.
- The Zoom `calendarServiceId` you want to sync.
- (Optional) A Zoom default location ID if you want the tool to create missing workspaces.
Once ready, and once confirmed that phase 1 is complete, continue with the steps below:
- Download and extract the Exchange Sync tool.
- Configure Zoom calendar integration.
- Configure the tool files.
- Run the Exchange Sync Tool.
- Verify the sync.
Download and Extract the Exchange Sync Tool
- Download the release package.
- Extract the files from exchange-sync-tool.tar.gz to a working directory on the server or workstation where you will run the tool.
After extraction, you should see an exchange-sync-tool folder containing the following files/folders:
- README.md - This contains step-by-step instructions
- darwin-arm64
- exchange-sync-tool (Unix Executable File)
- darwin-amd64
- exchange-sync-tool (Unix Executable File)
- config.example.yaml
- version.txt
- linux-arm64
- exchange-sync-tool (Unix Executable File)
- linux-amd64
- exchange-sync-tool (Unix Executable File)
- windows-amd64
- Create a copy of config.example.yaml and rename the copy to config.yaml.
- Open the config.yaml file.
Note: You can use a text editor app such as TextEdit for macOS or Notepad for Windows to open this file. There are also text editor apps that show a different font color for the information that needs to be filled out in the file.
For macOS users, if you encounter a message that says the file may harm your device or compromise your privacy, do the following.
- Go to System Settings.
- On the side menu, click Privacy & Security.
- Scroll down and look for the blocked to protect your Mac prompt.
- Click Open Anyway. A window that says Apple is not able to verify that it is free from malware appears.
- Click Open Anyway from the prompt. Enter your macOS admin credentials.
- Re-run or re-open the app or file.
- Fill out the following information:
- Under Exchange settings:
- organization
- appId
- certificateThumbprint
- certificateFilePath
- certificatePassword
- Under Zoom API settings
Note: The information required for this section can be obtained from the API created when Automatic User Provisioning was done. If the app has not yet been created, you can follow the steps here.
Create the app
If Automatic User Provisioning hasn't been set up yet:
- Sign in to the Zoom App Marketplace.
- In the top-right corner, click Develop, then Build Server-to-Server App.
- Enter an app name and click Create.
- On the App credentials tab, copy the account ID, client ID, and client secret.
- On the Information tab, fill in the required app information.
- On the Scopes tab, click Add Scopes and add the required Zoom permissions or scopes.
- Click Continue.
- On the Activation tab, activate the app.
Required Zoom permissions or scopes
Core (read/sync):
- View Zoom Rooms calendar services
- View a Zoom Rooms calendar service's calendar resources
- View workspaces
- Get a workspace's settings
- View Zoom Rooms location hierarchy's locations
- Workspace update setting
- View users
- View groups
These scopes are optional but might be required depending on what is configured to be synchronized.
- View a group's member; Add these scopes only when sync.allowSyncDynamicGroups=true.
- Create a group; Add this scope only when sync.mode=sync and sync.allowSyncDynamicGroups=true and sync.allowCreateDynamicGroups=true.
- Update a group; Add this scope only when sync.mode=sync and sync.allowSyncDynamicGroups=true and sync.allowUpdateDynamicGroups=true.
- Add members to a group; Add this scope only when sync.mode=sync and sync.allowSyncDynamicGroups=true and sync.allowAddDynamicGroupMembers=true.
- Remove a group's member; Add this scope only when sync.mode=sync and sync.allowSyncDynamicGroups=true and sync.allowRemoveDynamicGroupMembers=true.
- Update a Zoom Rooms calendar service; Add this scope only when sync.allowSyncResources=true.
- Create a workspace; Add this scope only when sync.mode=sync and sync.allowCreateRoomsForUnbindResource=true.
Where to get your Calendar Service ID
- Sign in to the Zoom web portal as an admin with the privilege to edit account settings.
- In the top-right corner, click your profile picture or initials, then click Admin Center.
- In the side menu, click Product configuration.
- Click Rooms or Workspaces, then click Calendar Integration.
- Select your Zoom Rooms Calendar Service application.
- Click into the Calendar resource.
- Copy the Service ID from the browser URL after the text https://app.zoom.us/workspaces/management/calendar/r/resource/list?serviceId= and paste it into the config file.
Run the Exchange sync tool
- In the config.yaml file, under Sync behavior settings, leave mode set to preview for the first run (dry run, no changes made).
- Open the exchange-sync-tool to run the tool from a terminal.
The tool pulls Dynamic Distribution Lists from Exchange, compares them to Zoom, triggers the calendar sync step, and writes a JSON report. - In the directory where the files from downloading and extracting were saved, open the reports folder and verify if a JSON file has been created. There is no indicator when the sync finishes; wait a fixed interval (the tool defaults to a short wait) before reading results.
Note: See the important notes on sync completion detection. - Review the JSON report and check the group info, membership, filter rule, and which members could/couldn't be matched to existing Zoom users.
- Once validated, in the config file, under Sync behavior settings, change the mode to sync.
- Re-run the exchange-sync-tool.
Sync settings reference
You can check the description of the sync settings below.
| Setting | Description |
|---|
| Mode | Preview (dry run — no changes applied)
Sync (applies changes)
|
| Sync group | Enables Dynamic Distribution List sync |
| Sync resource/calendar | Triggers calendar resource sync |
| Create/update/add-member/remove-member toggles | Fine-grained control over which DDL changes the tool is allowed to make |
| Report/snapshot path | Where the tool writes a JSON report after each run |