Minimum Version Required: 22.05
Pre-Conditions
1. Enable OAuth under System Setting 409.
Steps
Register an Application in the Azure Portal
1. Go to the Microsoft Azure portal and select View under Manage Azure Active Directory.
2. Select App Registrations and then select New Registration.
3. Enter the following values in Register an Application.
a. Input name, recommended Encompass or Encompass - {{Your Company}}.
b. Input redirect URI field as https://{{YourEncompassSiteAddress}}.com/aspx1/OAuth.aspx and select Register.
4. On the Overview tab, save the Application (client) ID for use later during the Encompass setup, then navigate to the Certificates and Secrets tab.
5. Click New Client Secret and create a new secret. Copy the client secret value (not secret ID) immediately after creation as it will only be displayed once, this secret will be used later during the Encompass setup.
6. Using Universal Search in Encompas, navigate to theOAuth Settings table.
7. Click the green Add OAuth Setting button
8. Select "Office365" in the service providers from the drop-down list, then input App ID and App Secret from steps four and five.
9. Copy and paste these values into the respective fields.
a. Request URL: https://graph.microsoft.com/v1.0/me
b. Authorization URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
c. Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
10. Setting Auto Verify Email to true will automatically create the link between Encompass user accounts to Office 365 user accounts that have the same email on the first time the user logs in with single sign-on.
11. Once linked users will be able to use the Office 365 icon on the login page to gain access to Encompass.
Manually connect an Encompass and Office 365 account
1. Log into Encompass.
2. Click on the user menu at the bottom of the Encompass sidebar, then select Profile.
3. Click Connect next to "Office 365" on the My Profile page.
4. Input the account login information to link with Encompass.
Fields And Definitions
Best Practices
Auto Verify Email
Leaving true will automatically link the login for any Encompass users whose Microsoft email matches the email on their Encompass user account
All other users can manually link their Microsoft account to their Encompass login via the My Profile dashboard
Roles -> Active Directory Group
This value can be configured to automatically set the Role on users in Encompass when they sign in by associating a Role in Encompass with a Group in Azure.
When a user signs in through SSO that has a Group assigned in the Azure Portal with an exact matching name to this value in Encompass, their Users.Role value in Encompass user will be updated to the role with the matching Active Directory Group.
See Microsoft's Register a client application in Microsoft Entra IDP for the latest steps on setting up an app in the Azure Portal.