To integrate Microsoft Outlook into the Bigtincan Hub using OAuth 2.0, you will need to follow the processes covered in this article:
-
Activate OAuth 2.0 in the Bigtincan Hub’s Platform Configuration
-
Generate Application In Azure Active Directory
-
Retrieve Client ID and Tenant ID
-
Create a Secret
-
Test Credentials
-
Test SMTP
As this integration is a highly compounding process, we recommend you follow the processes provided in the order designated for a smooth integration.
Vocab Terms
|
The Credentials |
Consists of Client ID, Tenant ID, and Client Secret. These credentials are generated in Azure and are needed for integration within the Bigtincan Hub. Note: The terminology in the Bigtincan Hub and Azure may differ slightly. Use the following for any clarification: Client ID= Application ID Tenant ID=Directory ID Client Secret= Value |
Activate OAuth 2.0 in the Platform Configuration
-
Navigate to Platform Configuration.
-
Select the “Email” tab.
-
Select the “SMTP” section.
-
This will bring you to a page with a single option: “Custom SMTP Server” .
-
Check the box titled “Custom SMTP Server”.
-
This triggers a variety of options to appear similar to the following:
-
Locate “Authentication Type” section and select the OAuth 2.0 option.
Register your Application in Azure Active Directory
Once the OAuth 2.0 option is selected in Platform Configuration, you will need to retrieve your:
-
Client ID
-
Tenant ID
-
Client Secret
These credentials are generated once the application is registered in the Azure Active Directory.
To begin the registration process:
-
Navigate to the Azure Active Directory .
-
Select the “+Add” option.
-
Select the “Enterprise application” from the drop down menu.
-
Select the “Create your own application".
-
A window similar to the following automatically generates:
-
Type in the application’s name in the provided text box.
-
Select the “Integrate any other application you don’t find in the gallery (Non-Gallery)” option.
-
Select “Create”.
-
Designate the account types allowed access to the application.
-
Select “Register".
- Once registered, the application will be added in the “Enterprise Application Tab > App Registration.” Browse the library to find your application.
Retrieving Client ID, Tenant ID:
Once your application is successfully registered, you can access the credentials (Client ID and Tenant ID) needed to integrate within the Bigtincan Hub. To find the Client ID and Tenant ID:
-
Navigate to “Azure Active Directory”.
-
Select the “App registrations” option.
-
Browse the list of applications and select your application.
- Under the “Essentials” section, find the Application (client) ID and Directory (tenant) ID. Copy and paste these in the respective sections in the Bigtincan Hub’s Platform Configuration.
Create a Secret
The final credential needed for the integration is the Secret. To generate a Secret:
-
Navigate to the tab labeled “Certificates & secrets”.
-
Under the “Client Secrets” section, select “New Client Secret”.
-
This prompts a window similar to the following:
-
Add a description.
-
Designate an Expiry time frame.
-
Select the “Add” option.
-
This will generate the credentials for the secret.
-
Copy the credentials listed in the “Value” box.The Value=Client Secret in the Bigtincan Hub.
*Note:This Value is only valid upon initial generation. If you navigate away from the “Certificates and Secrets” page before copying the Value, you will not be able to retrieve it. A new secret will have to be generated. -
Paste the Value into the “Client Secret” section of the Bigtincan Hub’s Platform configuration.
Grant Azure Active Directory Permissions
Before testing the credentials, you must provide the following permissions for the application:
-
Mail.Send Permissions
-
Grant Admin Consent
Grant Mail.Send Permissions
-
Select the “API Permissions” tab
-
Select the “+ Add a permission”:
-
Select Microsoft Graph Permissions:
-
This will prompt a window similar to the following:
-
Select the “Application Permissions” option
-
Search for “Mail” permissions in the provided text box
-
Select “Mail.Send”
-
Select “Add Permissions”
Grant Admin Consent
Once the Mail.Send permission is added, you need to Grant Admin Consent.
-
After you have added the permission, you will see a screen similar to the following:
-
Select the “Grant admin consent for Bigtincan” option shown above.
-
Once granted, you will see the update listed under the Permission’s Satus similar to the following:
With all the appropriate permissions designated, you can now test the credentials and SMTP Settings!
Test Credentials and SMTP Settings
To finalize the integration, you will need to test:
-
The Credentials (Client ID, Tenant ID, and Client Secret)
-
The SMTP Settings.
Testing the Credentials.
Once the credentials are entered into the respective text boxes within the Bigtincan Hub and the proper permissions granted in Azure, you may test the credentials by selecting the “Test Credentials” option.
If credentials are successful, you will see the “Authentication Successful” label appear.
Select the “Save” option in the upper right of the window.
Next, test the SMTP Settings.
Testing SMTP Settings
*Note: Make sure the “System Generated Email” field is set to a valid email address in your Azure Active Directory & the “User Generated Email” field is set to “User Email” - this will make sure emails that are sent from Bigtincan appear from the correct User’s email address and the email sent from Bigtincan will appear in the senders “Sent” folder in Outlook.
**Note: User emails must match the system-generated domain to be sent from the user's address.
Don’t forget to Save these settings before Testing SMTP Settings or leaving the page!
-
Locate the “Test SMTP Settings” section at the bottom of the page.
-
Enter an email address to which you will send the test.
-
Select the “Test Settings” option.
-
If successful, the recipient will see an email similar to the following:
