Entra ID App Registration for Federated Authentication, Swyx / Microsoft Teams Presence Status Synchronisation and Swyx Direct for MS Teams with PowerShell for Swyx 15ff

Enreach Info
Enreach Info
  • Updated

This article provides a PowerShell script that allows you to create the EntraID app registrations required for federated authentication, bidirectional Swyx/Microsoft Teams presence status synchronization, and the Swyx Direct for MS Teams feature.

 

Prerequisites

  • PowerShell >=7
  • Microsoft.Graph PowerShell module (use Install-Module Microsoft.Graph to install)
  • EntraID account with the right to manage app registrations in your Entra ID


Create Entra ID App Registrations


The script offers two modes: one for setting up the app registration for Swyx EntraID federated services, which includes SSO, MS Teams presence sync, contact sync, and calendar sync, and another for setting up the app registration for Swyx MS Teams Direct Routing provisioning.

1. Run the script:

.\RegisterSwyxEntraIDApp.ps1


and follow the instructions. The script uses default settings, which means it sets up the necessary permissions for using Swyx Entra ID federated services or Swyx MS Teams Direct Routing.

NOTE: The “Friendly App Name” for the app registration for federated authentication is a string that users will see when logging in.

NOTE: By default, the script includes all the app permissions needed for every function of the Swyx Entra ID federated services. If you remove permissions for functions you don’t use, keep in mind that you’ll have to add them manually later, such as through the Azure portal.

For Swyx Direct for MS Teams, the script also lets you remove the Entra ID roles that are only needed during onboarding.

2. Copy IDs

Copy the IDs and, where applicable, URLs that the script outputs at the end. You will need these values in the next step.

3. Configure Swyx

Use Swyx Control Center to configure the EntraID federated services or Swyx Direct for MS Teams. Details can be found in the Swyx manual at https://help.enreach.com

4. Remove EntraID permissions

For MS Teams Direct Routing, the script sets up some permissions that are only needed during the initial setup. Once you’ve successfully configured Swyx Direct for MS Teams in the Swyx Control Center, you should remove the unnecessary permissions from the app registration. To do this, run the script again with these parameters (using the application ID generated by the script for the Swyx Direct for MS Teams app registration):

.\RegisterSwyxEntraIDApp.ps1 -RemoveOnboardingRoles -ApplicationID "<Swyx Direct for MS Teams App ID>"

Script Online Help

The script supports PowerShell's get-help functionality. Use for the complete help:

Get-Help -Full .\RegisterSwyxEntraIDApp.ps1

or 

.\RegisterSwyxEntraIDApp.ps1 -?

for the concise version.

 

Was this article helpful?

0 out of 0 found this helpful

Have more questions? Submit a request

Comments

0 comments

Please sign in to leave a comment.