Registering BOLD Email Integration as an app in Microsoft 365 enables BOLD to authenticate to your Microsoft 365 tenant on behalf of BOLD users using their user account. By default, a newly registered app won't have any permissions, so you'll also need to assign appropriate roles to the application to enable BOLD Email Integration to sync Microsoft 365 mailboxes and send emails.
Key Takeaways
-
Register Application: Begin by registering the app in Microsoft 365, generating a client secret, and obtaining the Application ID. Ensure you choose the right permissions, including delegated and application permissions.
-
Configure Web Application Authentication: Set up the web application authentication by specifying redirect URLs, allowing BOLD Email Integration to interact securely.
-
Create User Groups: Create a user group and assign users who are authorized for BOLD Email Integration. The guide explains the necessary steps to link the group with the application. Be mindful of limitations related to the Entra plan used.
CHAPTERS
Admin Setup
Register the app
Create Client secret
Copy the Application ID
Add API permissions
Setup to configure Web Application Authentication
Create User Groups
Add a new Group to the Application
References
Outlook Service Limits
Admin Setup
Register the app
- Log into the Office 365 portal
- Click on Overview
- Click on the Add button
- Click on App registration
- Enter a name for the application, in the Name field
- Suggested to use: Bold_Email_Integration. We recommend not to include any spaces and use underscores instead.
- Suggested to use: Bold_Email_Integration. We recommend not to include any spaces and use underscores instead.
- Select the Accounts in any organizational directory (Any Microsoft Entra ID Tenant - Multitenant) option
- Click on the Register button
Create Client secret
- On the main App Registration page, locate and copy the Application (client) ID, as it will be used in a later step.
- On the left, click the Certificates & Secrets button.
- Click on the New client secret button
Note: After creation be sure to save the client secret as it will only be available for a short time.
This and the application (ClientId) will need to be configured in Utilities in a later step
- Enter a name in the Description field
- Select the expiration from the Expires drop down field.
- We recommend selecting 24 months, the maximum amount of time that can be selected. Please also note the date this will expire, so you can update this secret before then, to ensure no interruption of service. For more information on how to update an expired Secret Value, please see our Knowledge Base article on that topic.
- We recommend selecting 24 months, the maximum amount of time that can be selected. Please also note the date this will expire, so you can update this secret before then, to ensure no interruption of service. For more information on how to update an expired Secret Value, please see our Knowledge Base article on that topic.
- Click on the Add button
- The Secret Value field will only be displayed on this screen. Once you navigate to another area, the Secret Value will never be displayed again. Ensure that you copy it here, and store it alongside the Application ID we previously copied, as they will both be required for a later step.
Add API permissions
- Click on the API permissions section
- Click on the Add a permission button
- Click on the Microsoft Graph tile
- Click on the Delegated permissions tile
- Use the search bar to locate all required permissions.
- Add the following permissions, by clicking the checkboxes:
-
IMAP.AccessAsUserAll
- Mail.Read
- Mail.Send
-
User.Read
-
- Once all above permissions are selected, click on the Add permissions button
- Click on the Add a permission button once more
- Click on the APIs my organization uses tab
- In the Apps in your directory that expose APIs search field, type: OFFICE
- Click on the Office 365 Exchange Online option
- Not all Microsoft subscriptions will have the Office 365 Exchange Online option. If not visible, add to the subscription first before proceeding. Please see the Microsoft Website on this topic for further information.
- Not all Microsoft subscriptions will have the Office 365 Exchange Online option. If not visible, add to the subscription first before proceeding. Please see the Microsoft Website on this topic for further information.
- Click on the Application permissions tile
- Use the search bar to locate all required permissions.
- Add the following permissions, by clicking the checkboxes:
-
IMAP.AccessAsApp
-
IMAP.AccessAsApp
- Click on the Add permissions button
- Ensure that all the APIs/Permissions are listed:
-
Details for API/Permissions
Located in Section API / Permission Name Type Description Admin Consent required OpenId permissions openid Delegated Sign in and read user profile
No IMAP IMAP.AccessAsUserAll Delegated Read and write access to mailboxes via IMAP No Mail Mail.Read Delegated Read user mail No Mail Mail.Send Delegated Sign users in No User User.Read Delegated Send mail as a user No IMAP Imap.AccessAsApp Application IMAP.AccessAsApp
Yes
-
- Click on the Grant Admin Consent button
- This option may be grayed out (unavailable), without the proper permissions.
Microsoft on Entra AD roles
- This option may be grayed out (unavailable), without the proper permissions.
Setup to configure Web Application Authentication
- Click on the Authentication section
- Click on the Add a platform button
- Click on the Web tile
- Enter the following link into the Redirect URIs field, replacing staffdemo with your company's subdomain: https://staffdemo.myavionte.com/sonar/api/oauth2/CallbackAuthTokenSync
- Click on the Configure button
- Click on the Add URI link
- Enter the following link into the Redirect URIs field, replacing staffdemo with your company's subdomain: https://staffdemo.myavionte.com/sonar/api/oauth2/CallbackAuthTokenSend
- Click on the Save button
Create User Groups
Create a user group that has access to this new application and assign users that are allowed BOLD Email Integration. Please note that if you are on the free version of Entra, you may not have the ability to create groups. If this is the case, please move on to the next section where you can instead add users to the integration individually.
- Click on the Groups section
- Click the All Groups button
- Click on the New group button
- Enter information for the following fields:
- Group Type: Select the Security option
-
Group name: BOLD_Email_Integration
-
Note: We recommend not to include any spaces and use underscores instead.
-
- Group description: Enter a brief description of the Group
- Entra roles can be assigned to the group: Toggle the switch to No
- Membership type: Select the Assigned option
-
Owners: No changes are needed
- Once all of the required information if selected, click Create.
- Within the group you have created, click the Members button
- Click the Add Members button
- Select all the members/users using the checkbox to the left of each of their names
- Once all members have been selected, click the Select button to add them to the group
- Enter information for the following fields:
Add a new Group to the Application
Select Enterprise Apps and BOLD Email Integration to add this group to the new Application
- Under the Enterprise Applications section on the left, click All Applications
- Using the search bar, locate and select the application we created in the first section of this process.
- Click on the Assign users and groups link
- Click on Add user/group
- Click on the None Selected link
- Click on the User Group that was created in a previous step.
- If the Entra Plan is a Free Tier, then the ability to select User Groups is not allowed. Instead, please select all the Users instead of a group at this stage.
- If the Entra Plan is a Free Tier, then the ability to select User Groups is not allowed. Instead, please select all the Users instead of a group at this stage.
- Click on the Select button
- Click on the Assign button
References
Outlook Service Limits
From the Microsoft article, Microsoft Graph service-specific throttling limits:
"Outlook service limits are evaluated for each app ID and mailbox combination. In other words, the limits described apply to a specific app accessing a specific mailbox (user or group). If an application exceeds the limit in one mailbox, it does not affect the ability to access another mailbox. The following limits apply to the public cloud as well as national cloud deployments."
Limit | Applies To |
10,000 API requests in a 10-minute period | v1.0 and beta endpoints |
4 concurrent requests | v1.0 and beta endpoints |
15 megabytes (MB) upload (PATCH, POST, PUT) in a 30-second period | v1.0 and beta endpoints |
3rd party link Disclaimer: These links are being provided as a convenience and for informational purposes only; they do not constitute an endorsement or an approval by [The author] of any of the products, services or opinions of the corporation or organization or individual. [The author] bears no responsibility for the accuracy, legality or content of the external site or for that of subsequent links. Contact the external site for answers to questions regarding its content.
Click on the links below for more information:
- Microsoft Outlook365 (Modern Auth) Summary
- Manually deactivate Custom SMTP & Email Auto-sync
- Activate the Outlook365 Tile (Marketplace)
- Initial setup for User using Office 365 (Modern Auth)
- Install Microsoft Authenticator App
- Custom SMTP setup
- Auto Sync Email setup
Comments
0 commentsPlease sign in to leave a comment.