Step 2. Azure AD synctool configuration UI
Table of Contents
Introduction
In this step, we’ll configure the synctool so it can connect both to AD and the Workspace.
All the data you have collected in step 1 can be filled in the configuration UI tool. You can find this tool in the downloaded Workspace 365 synctool folder. When you unzip the folder, the name of the file is: NDAW.AzureActiveDirectorySync.ConfigurationTool.
Configuration UI synctool
Let's get started
To disable the welcome page, uncheck checkbox at the bottom of the page. You can change the default language to Nederlands or English. Click Next to continue.
Connect to Azure AD
To connect the Azure AD synctool to Azure Active Directory, fill in the fields below (data collected from step 1). Click Next when all information is entered. Here, the connection to the entered information/Azure AD will be validated.
- Tenant ID
- Tenant name
- Application (client) ID
- Client secret (value)
Environment settings
To add a new environment, fill in the following and click on 'Save' when you're done:
- Your Workspace site URL: this is the workspace base URL where all the environments are hosted on, mostly 'https://{companyname}.workspace365.net'.
- Environment name: this must match exactly with the environment name in Workspace 365 and can be retrieved from the Workspace 365 URL, e.g. 'https://portal.workspace365.net/john -> john'.
- Sync API authentication token: this can be retrieved from the Workspace 365 environment 'Users & groups > Active Directory'. Click here for more information.
Domain filtering
If you want to enable domain filtering, check the enable domain filtering checkbox. This will expand and show all domains and subdomains within the current domain.
You can make a selection of the desired domains you want to sync. All users with the domain prefix selected will be synced in this case:
- johndoe@ndawdev.onmicrosoft.com
- carter@ndawdev.onmicrosoft.com
Will not be synced:
- bay@subdomain.ndawdev.onmicrosoft.com
Group filtering
If you want to enable group filtering, check the enable group filtering checkbox. This will expand and show all groups within this current domain.
Here you can make a selection of the desired groups you want to sync. All users within the selected group and the group itself will be synced in this case:
- All members of ‘Anton League’
- All members of ‘prefix1demo_1’
- Group ‘Anton League’
- Group ‘prefix1demo_1’
Will not be synced:
- All other groups that are unchecked including the users
Domain- and group filtering
It is possible to combine both, domain- and group filtering, as shown below:
We have the following active directory structure:
- 24631 development
- johndoe@ndawdev.onmicrosoft.com
- Anton League
- rhodes@ndawdev.onmicrosoft.com
- App search
- prefix1demo_1
- carter@ndawdev.onmicrosoft.com
- bay@subdomain.ndawdev.onmicrosoft.com
If domain filtering is enabled and the following checked:
- onmicrosoft.com
If group filtering is enabled and the following is checked:
- Anton League
- prefix1demo_1
The following users and groups will be synced:
- All members of ‘Anton League’ with the ndawdev.onmicrosoft.com domain
- rhodes@ndawdev.onmicrosoft.com
- All members of ‘prefix1demo_1’ with the ndawdev.onmicrosoft.com domain
- carter@ndawdev.onmicrosoft.com
- Group ‘Anton League’
- Group ‘prefix1demo_1’
Will not be synced:
- All other groups and domains that are unchecked including the users
Synchronization settings
Click on preferences to open the synchronization settings menu.
You can set the synchronization time to Periodical or Once a day. If you choose to set the synchronization type to 'Periodical' you need to define the interval in hours and/or minutes. If you choose to set the synchronization type to 'Once a day', you need to define at which time you want to run the sync.
Clear cache
So what is a clear cache? The admin tokens of previous syncs/connections will be cleared and renewed when choosing "Clear cache". So this option will clear the user history. If users are not being updatet or added to specific groups, clearing the cache may fix this issue. To clear the cache, follow these steps:
- Make sure the checkbox of the synctool is enabled in Workspace.
- Stop the synctool service. This way, you make sure the synctool button won't trigger while executing the clear cache.
- Select the “Clear cache” button and press “Ok”.
- Run the synctool manual in the synctool directory as an administrator.
- Wait until the user is added to the Workspace.
- Start the synctool service.
Proceed to step 3.
