Microsoft 365 Integration
The PortSIP PBX integrates with Microsoft 365 to provide the following features:
Synchronous user accounts from Microsoft 365 or Azure Active Directory (Local Active Directory synced to the cloud using Azure Connect).
Allow users to use their Microsoft Account to log in to the PortSIP WebRTC Client.
Microsoft 365 Users' personal contacts are synchronized with the PortSIP PBX user's personal contacts.
Shared mailbox contacts are synchronized with the PortSIP PBX Company contacts.
Pre-Requisites
You need PortSIP PBX running on a static public IP address.
A web domain (which is FQDN) in PortSIP PBX with a valid SSL certificate. The certificate should be issued by a trusted certificate provider such as Digicert, Thawte, Godaddy, etc. You can read this article to configure the SSL certificate.
Requires the PBX tenant who wants to enable the Microsoft 365 integration to have Microsoft 365 Accounts with an Exchange subscription plan:
Microsoft 365 Business Basic, Standard, or Premium
Microsoft 365 F3, E3 or E5
Configuring Microsoft 365 Access
Configure the App ID for the Tenant
To enable synchronization between PortSIP PBX and your Azure or Microsoft 365 account, follow these steps:
Sign in to your Azure or Microsoft 365 account.
Navigate to Microsoft Entra ID:
Click the Microsoft Entra ID icon.
In the left-hand menu, select App registrations.
Click New registration to create a new application.
Enter a name for the application: For example: PBX Server-side.
Configure supported account types: Choose Accounts in this organizational directory only (Single tenant: PortSIP Solutions, Inc. only).
Sign in to the PortSIP PBX web portal: Log in as the Tenant Administrator, or switch to the tenant scope if you are logged in as a PBX System Administrator.
Copy the Redirect URI: From the Advanced > Microsoft 365 Integration menu, copy the Redirect URI. There may be two Redirect URIs if you configured the PortSIP SBC; please copy them both.
Paste the Redirect URI into Microsoft 365 and save. If you have two Redirect URIs, paste one first; the second URI will be added later.
Copy the Application (client) ID and Directory (tenant) ID from Microsoft 365.
Please remember to save the Directory (tenant) ID for later use. You just need to copy and paste the Application (client) ID into the PBX as in the below screenshot for now.
If you have installed and configured the PortSIP SBC with the PBX, you will have two Redirect URIs in the PBX web portal. The first URI was added in the previous step.
Next, follow these steps to add the second URI:
Navigate to the App registrations menu in your Azure or Microsoft 365 account.
Select the application you configured in Step 7.
Click on the Authentication menu, then select Add URI.
Paste the second Redirect URI and save your changes.
Important: If your PBX web domain or SBC web domain changes in the future, make sure to update the Redirect URIs in Microsoft 365 accordingly.
Generate Key Pair
Now generate the certificate public key for Microsoft 365 (go to the PortSIP PBX Web portal menu Advanced > Microsoft 365 Integration).
Click the button Generate New Key Pair, and download the public_key.pem file.
Go to Microsoft 365, and upload the public_key.pem file to Microsoft 365 by clicking the Upload certificates.
By default, the certificate is only valid for one year. To maintain the validity of your MS 365 integration, you must regenerate the certificates and repeat the previously mentioned steps to update them before the current certificate expires each year.
Sync Options
Select the PortSIP PBX Web portal menu Advanced > Microsoft 365 Integration to configure the options for sync with Microsoft 365.
Schedule a time for the PBX system to synchronize with Microsoft 365 users. Suggest set it to occur at midnight (00:00).
directory_id: Paste the Directory (tenant) ID (which you saved in above step 8).
national_cloud: National clouds are physically isolated instances of Azure. These regions of Azure are designed to make sure that data residency, sovereignty, and compliance requirements are honored within geographical boundaries.
Including the global Azure cloud, Microsoft Entra ID is deployed in the following national clouds:
Azure Government
Microsoft Azure operated by 21Vianet
Currently, PortSIP PBX supports Global Azure cloud and Microsoft Azure operated by 21Vianet. Please choose the GLOBAL unless you are sure you need to connect with Microsoft Azure operated by 21Vianet.
If both the first name and last name fields are empty for a Microsoft 365 user, but the email address is not, the user will not be synchronized with PortSIP PBX. This limitation is imposed by Microsoft 365.
Configuring API Permissions
Select the menu API permissions, click Add a permission, and then select the Microsoft Graph.
In the Microsoft Graph page as shown below, click on Application permissions. Then, type each of the permissions listed below into the Select permissions field. After selecting them, click on the Add permissions button.
User.Read.All
Contacts.Read
Once all required permissions have been successfully granted, it will appear as shown in the screenshot below.
Configuring User Synchronization
Now you need to synchronize the users from Microsoft 365 to PortSIP PBX:
Set the extension number range to be assigned to Microsoft users. You can configure a starting extension, otherwise, it will use the first available extension.
The synchronization is one-way (Microsoft 365 to PortSIP PBX) and happens every middle night(time 00:00) or the custom time that you scheduled. If you have not deleted the user in Microsoft 365 it will reappear in PortSIP PBX the next day.
You can sync Microsoft 365 user photos to PortSIP PBX to show the photo as a profile picture in the apps and in the WebRTC client.
Configuring SSO
Once Microsoft 365 is successfully integrated, a Microsoft icon will appear on both the PBX Web portal and WebRTC Client login pages. This indicates that Single Sign-On (SSO) is enabled. Users can then click on this icon to log in to the PortSIP web portal and WebRTC client using their Microsoft credentials.
Configuring Contact Synchronization
You can have personal 365 contacts synced to the PortSIP PBX user's personal contacts. This is a one-way synchronization: Contacts need to be managed and updated from Microsoft 365. You can do the same for Microsoft 365 shared mailbox contacts and synchronize these with the PortSIP PBX company contacts. All contacts in “Well-Known Folders” (Default) folders will be synced.
Last updated
