Azure Applications
Introduction
Lucy offers the capability to integrate with Azure for importing users, distribute awareness training via SMTP, and implement the Microsoft Graph API XML reporting plugin. Administrators can synchronize several Azure applications, organized by client, to ensure applications are accessible solely to administrative users associated with the respective client.
Creating an application in Azure
See here for a guide on setting up an application in Entra ID: https://learn.microsoft.com/en-us/entra/identity-platform/quickstart-register-app
Redirect URIs
Lucy can sync with Entra ID for a few different purposes. Depending on your use-case you will need to configure the correct URIs:
https://example.com/oauth/
https://example.com/oauth/admin
https://example.com/oauth/user
https://example.com/oauth
https://example.com/login/login.html
https://example.com/new-o365/dist/index.html
https://example.com/oauth
https://login.microsoftonline.com/common/oauth2/nativeclient
https://login.live.com/oauth20_desktop.srf
msal<application_id>://auth
Add an application to Lucy
On this page you can view, add, and delete Azure applications in Lucy.
To add an application, select + Add Application. On the page that follows, fill out the application details:
This is the Lucy client associated with the Azure app registration. Lucy ensures data segregation on a client basis, meaning that all data is containerized within the respective client. This setup guarantees that the app integration remains accessible solely to administrative users for the specified client. Moreover, it enables Managed Security Service Providers (MSSPs) and Partners to integrate multiple Azure tenants for their respective clients, further enhancing security and customization.
After configuring all the parameters mentioned above, proceed by clicking "Save". After saving the application, a new button will appear labeled "Authorize". Click this button to grant the required permissions to your Azure application.
This action will redirect you to the Microsoft authentication page, where you will be asked to provide consent on behalf of your organization. This consent is necessary to establish the connection between Lucy and Azure.
To integrate Lucy with your Azure App Registration, it's essential to have Global Azure Administrative consent for your organization. If the administrator account in Lucy lacks the necessary privileges to grant consent on behalf of the organization, refer to the guide provided below to establish a consent flow in Azure.
Setup Admin Consent flow in Azure
Purpose
The integration of third-party applications like Lucy with Azure requires careful configuration to ensure API permissions are correctly set. This is crucial for applications such as Lucy demanding access beyond the Azure permission set of the Lucy administrative users. A common challenge faced during integration is a permissions mismatch, leading to integration errors. This guide aims to navigate administrators through the consent framework in Azure, enabling Lucy to receive the necessary permissions while upholding the security and integrity of the Azure environment.
Who Should Use This Guide?
This guide is intended for Lucy Administrators who lack Azure Administrative privileges to grant organizational consent, as well as situations where Lucy servers operate without an Azure Administrator to facilitate the saving of Azure application configurations within Lucy.
Lack of Administrative consent is evident if the following message is displayed after saving your application in Lucy:
Configuration
Accessing Azure
Log into the Azure Portal: Start by visiting portal.azure.com and logging in with your credentials.
Setting Up Consent Flow
Navigate to Microsoft Entra ID: Find and select the Microsoft Entra ID option to proceed.
Enterprise Applications: In the Microsoft Entra ID section, locate and click on “Enterprise Applications.”
Consent and Permissions: Inside Enterprise Applications settings, select “Consent and Permissions.”
Admin Consent Settings: Search for “Admin consent settings” and click it to modify the consent flow settings.
Enable Consent Requests: Activate the option “Users can request admin consent to apps they are unable to consent to” by toggling it to “Yes.” This allows non-admin users to request admin consent for applications.
Designate Reviewers: Specify Azure Administrative users for the consent review process, selecting your Azure Admin under Review Type as Users.
Save Your Settings: Click “Save” to apply the changes.
Finalizing Configuration in Lucy
Adjustments in Lucy: Instruct the Lucy admin to try saving the application configuration again, preferably using an incognito window to avoid caching issues.
Consent Request Initiation: The Lucy admin will see a consent request dialog, allowing them to submit a consent request to the Azure Admin.
Consent Approval Process
Initiating Approval: The Lucy admin clicks “Request Approval” to start the consent process.
Notification to Administrator: An approval request is sent to the Azure Administrator's email, and the request appears under Enterprise Applications -> Admin Consent Requests in the Azure portal.
Admin Review and Consent Granting: The Azure Administrator reviews the request in the portal and grants consent on behalf of the organization.
Confirmation to Lucy Admin: The Azure Administrator should inform the Lucy admin of the consent approval.
Completing Integration
Finalizing in Lucy Settings: The Lucy admin goes to Common System Settings -> Azure Applications in Lucy, selects the application, and clicks “Save” to proceed with the integration.
Microsoft Login and Token Allocation: This prompts the Lucy admin to log in with Microsoft credentials again to generate a refresh token for the integration.
Binding to Lucy Server: Successfully obtaining the refresh token completes the integration, effectively binding the Azure app registration to the Lucy server.
What API permissions are required for this integration?
API Permissions explained
OpenID
Delegated
Sign users in
No
offline_access
Delegated
Maintain access to data
No
Delegated
View user's email address
No
User.Read.All
Delegated
Read all users' full profiles
Yes
GroupMember.Read.All
Delegated
Read group memberships
Yes
Last updated
Was this helpful?