Background
Entra ID (previously Azure AD) is Microsoft’s active directory tool used by many companies to store employee details and provision access to different applications.
This integration allows Organisation Support users to set up a directory sync with Entra ID to create a Datasheet that is synced with Entra ID and pulls employee directory information from Entra ID into Avvoka at a set interval.
Set-up process on Microsoft
1. Navigate to the Azure portal (https://portal.azure.com) and navigate to “Microsoft Entra ID”.
2. Next, click on “Enterprise applications” and click “New application”.
3. Click “Create your own application” and provide the name “Avvoka Entra ID integration”. Select the option to “Integrate any other application you don’t find in the gallery (Non-gallery)”, then click “Create”.
4. After the application has been created, go back to the Entra ID homepage, and navigate to “App registrations”. Click on “All applications” and navigate to your newly created application.
5. Click on “API permissions”, click “Add a permission” and select “Microsoft Graph”
6. Select “Application permissions” and add the following permissions:
6.1 “Group.Read.All”
6.2 “GroupMember.Read.All”
6.3 “User.Read.All”
7. An administrator will need to grant admin consent for the application. After that is complete, it should show that the permissions have been granted for the tenant under the “Status” column.
8. Next, navigate to “Overview” and create a client secret by clicking “Add a certificate or secret”. Then, click “New client secret”. Provide the description “Avvoka production secret” and choose an expiry duration. Then click “Add”.
9. Note down the “Value” of the secret.
10. Head back to “Overview”, and note down the following:
10.1 “Application (client) ID”
10.2 “Directory (tenant) ID”
Set-up process on Avvoka
1. As an Organisation Support user, log into Avvoka and navigate to “Support”, select your organisation, and go to the “Integration settings” tab and scroll to “Entra ID Settings”.
2. Tick “Enable integration for all members of this organisation”.
3. Provide the following details, then click “Save”:
Tenant Name | Provide the name of your Microsoft365 tenant |
Tenant ID | Provide the “Directory (tenant) ID” from step 10.2 |
Client ID | Provide the “Application (client) ID” from step 10.1 |
Client Secret | Provide the “Value” of the secret from step 9 |
4. Under “Organisation-wide authorization”, click “Authorise”, if successful, it should show “Currently authorised with client credentials method”.
Creating a synced datasheet
1. To create a synced datasheet, click “Create Synced Datasheet”.
2. Provide a name, select the relevant organisation and profile, and select a sync refresh schedule.
a. You can select from either “Every 30 minutes”, “Hourly” or “Daily” for the sync schedule. Note: the sync will take place on every half-hour mark, hour mark, or at 00:00H, respectively.
3. You can also provide a specific Entra ID group ID if you’d like to narrow this synced datasheet to members of a specific group.
a. The Entra ID group ID can be found under the “Groups” tab in Entra ID, in the column “Object Id”.
4. You can then add headers for which user properties you would like to sync.
a. Give the Datasheet column a name and select the relevant Entra ID attribute.
5. The Datasheet then functions as a regular Datasheet on Avvoka and can be used in templates.
5a. Please note that the synced datasheet does not allow records to be amended or added.
5b. Organisation Support users can manually refresh the synced datasheet.