If your organization uses Microsoft Azure Active Directory (Azure AD) as well as Employee Email, you have the option to sync user information from your Azure AD instance(s) to your list of Employee Email contacts.
You can also sync Workday users as Employee Email contacts.
- Your synced contact information is kept up to date automatically on a regular schedule.
- Use your imported contacts to build custom distribution lists in the web app.
- Optionally, sync your organization's existing Azure synced distribution lists directly from your Azure AD instance(s).
- You can set up multiple integrations with Azure AD to sync different collections of user data to Employee Email, or sync from different instances within your organization.
Note: This functionality is only available if you send emails directly from the Employee Email web app. This article is not relevant if you have installed an add-in or extension and you send tracked emails from your email client.
If you have the Staffbase App/Intranet integrated with Employee Email, the most efficient way to set up your contacts is by creating users in your App/Intranet, then configuring how your employees are synced as email contacts.
Prerequisites
- You have an Employee Email account with the required access enabled
Staffbase recommends using an Admin or Parent Admin account
Note: Starting November 9, 2022, if enabled, new Feature Access settings let you allow users to Create and edit integrations while restricting their ability to Edit field mapping and exclusions.
Both of these permissions are required for a user to connect Employee Email to Azure AD.
Ask your Customer Success Manager for details. - Your organization has an Azure AD environment
Note: If your organization currently uses an on-premises (on-prem) version of Active Directory, you can still sync your user accounts to Employee Email via Azure AD Connect, a tool provided by Microsoft for free as part of your Azure subscription that enables you to sync identity data between your on-prem environment and the Azure cloud. - You have an Azure AD account that can be used to maintain the sync
Staffbase recommends using a service account rather than an individual user’s account - You have the ability to approve access for the service account with Global Administrator credentials
Connecting Employee Email to Azure AD
- In a new Incognito or InPrivate browser window, sign into the Employee Email web app.
- Navigate to Contacts > Import.
- Click the Azure tile.
- Enter a unique title for your organization's Azure AD that will be easy to recognize later.
- Click Create.
A success message displays confirming that your integration has been created. - Click Connect Active Directory.
- Ensure that your browser allows pop-ups from your Employee Email web app.
A new dialog displays, prompting you to sign in with Microsoft credentials. - Sign in with the Azure AD account that will be used to maintain the sync.
Staffbase recommends using a service account with Global Reader access.
You are prompted for admin approval. - Sign in with Azure AD Global Administrator credentials.
Note: If the prompt for admin approval does not display automatically, troubleshoot by starting again from step 1 and ensure you are using an Incognito or InPrivate browser window.The Microsoft sign-in dialog closes and your integration displays as Connected.
Contact your Technical Onboarding Engineer or Onboarding Project Lead for further assistance.
- Click Next to continue the import process.
What Is Happening in Your Azure AD Instance
When you sign into Azure AD through Employee Email, we are going through this process:
Get access on behalf of a user - Microsoft Graph
Authorization from a Global Admin is required to establish the Azure enterprise tile app in your environment and grant the following scopes to your service account:
Directory.Read.All
openid
offline_access
For interacting with the directory, we go through two different graph endpoints (one for users, one for groups), both using the access token we acquired from the first step.
- List users - Microsoft Graph v1.0 - Retrieve a list of user objects.
- List groups - Microsoft Graph v1.0 - List all the groups available in an organization.
This includes but is not limited to Microsoft 365 Groups.
Importing Distribution Lists from Your AD
Optionally, choose existing Azure AD distribution lists to import into Employee Email. All of your organization's Microsoft 365 Groups and mail-enabled security groups will be available to select.
If your organization has more than one thousand groups available to choose from, you are prompted to use the Bulk Selector and upload a CSV file containing only the Display Name of each list that you want to sync. Do not include a header row in this spreadsheet.
Mapping Your Azure AD Fields
The Map fields tab opens, and employee attributes stored in your Azure AD, like names, titles, office locations, etc., are auto-populated under the Imported Field section.
Attributes are the characteristics that differentiate one recipient from another, which enable you to segment your audience and target your communications to specific groups.
- From the dropdown menu corresponding to each value, select a field name to map the attributes from your Azure AD to fields in Employee Email.
Tip: Some fields are mapped automatically but can be adjusted based on your preference.Optionally, select Skip this field for any of your imported fields except the Unique Contact ID, which defaults to Email.
Starting November 9, 2022, Employee Email will also expose your Azure AD custom attributes (1-15). When syncing or mapping contact data, you will be prompted to decide whether to map or skip these fields.
If there is no existing option in the dropdown that matches your imported field(s), create a new Text, Number, or Date field.
- Optionally, find and import additional custom fields from your Azure AD.
You will need to know which fields you want to import. An Azure AD Global Admin in your organization will be required to help find the Field unique ID(s) for these fields.
Excluding Contacts From Syncing
Optionally, create filters to exclude some categories of Azure AD contacts from your import.
For example, exclude employees who are currently on leave with an Inactive status, or belong to a division that does not need to receive communication emails.
Note: The values that you type in manually must exactly match the ones used in your Azure AD.
The fields are case-sensitive.
Completing and Confirming Your First Sync
- Click Sync to import your contact data and complete the configuration.
A new page displays, showing a progress bar for your import.
Note: The import process usually takes 10-30 minutes but may require a number of hours for a very large organization. It cannot be stopped or restarted.You are free to navigate around the Employee Email web app while you wait. This will not disrupt the import.
- Navigate to Contacts > Directory to view your imported data.
The All Contacts list opens. - Click Distribution Lists to view any lists you have imported.
These distribution lists will be updated automatically each time your Azure AD users are synced to Employee Email.
If you want to make changes to them, do this in your Azure AD and not in the Employee Email web app. - To check for and fix any potential errors with your import, navigate to Sources > Integrations.
Editing or Deleting a Synced Azure AD Instance
- In the Employee Email web app, navigate to Contacts > Sources > Integrations.
- Click the three dots next to an integration.
Any Employee Email user with the required access enabled can manually sync Azure AD contacts from the integration that you have created or edit its field mappings.
Note: Starting November 9, 2022, if enabled, new Feature Access settings let you allow users to Create and edit integrations while restricting their ability to Edit field mapping and exclusions.
Both of these permissions are required for a user to connect Employee Email to Azure AD.
Ask your Customer Success Manager for details.
When syncing or mapping contact data after November 9, Employee Email will also expose your Azure AD custom attributes (1-15). You will be prompted to decide whether to map or skip these fields.
Only the Employee Email account that configured an integration, or a Parent Admin, can delete that integration.
Unless they are removed from Azure AD or excluded from syncing, these contacts will appear in the web app again after the next sync.
Comments
0 comments
Please sign in to leave a comment.