Configure AIM to use Microsoft Entra ID for Accessing the Dashboard
- Last UpdatedJul 23, 2024
- 4 minute read
To configure AIM to user Microsoft Entra ID for access to Dashboard website:
-
Log in to the Azure portal, for example https://portal.azure.com/#home.
-
Select Microsoft Entra ID from the side menu bar.

-
Select App registrations from the side menu bar to create an app registration.

-
Select New registration to create a new registration.

-
Provide a Name, Supported account types and Redirect URI. For example:

-
When the registration is created, in the Overview section you will see details similar to those below. Make a note of the Application (client) ID and Directory (tenant) ID which will be used for the AIM setup.

-
Navigate to Expose an API and set the Application ID URI, scope and client application.

-
Set the Application ID URI by selecting Set.

-
By default, api://{clientId} will be present, so just add /AIM after {clientId}. Then select Save. For example:

-
Select Add a scope. The Add a scope window opens.
-
Enter the details as shown in the following example.

-
Select Add scope at the bottom of the window.
-
Navigate to Overview and copy the Application (client) ID.

-
Navigate to Expose an API and select Add a client application.

-
Paste the value of the copied Application (client) ID into the Client ID field.

-
Select the checkbox under the Authorized scopes section.
-
Select Add application.
-
Navigate to Manifest and update the accessTokenAcceptedVersion value to 2 to get the preferred_username claim.
-
Update the groupMembershipClaims value to SecurityGroup or All to get the groups claim.
For groupMembershipClaims, a value of null excludes all groups, a value of SecurityGroup includes only Active Directory Security Group memberships, and a value of All includes both Security Groups and Microsoft 365 Distribution Lists.
-
Select Save.
Note: Ensure that the user is not in more than 200 groups (for JWT tokens). For more information, see https://learn.microsoft.com/en-us/entra/identity-platform/security-tokens.

-
Configure AIM’s web.config to use Microsoft Entra ID Authentication (Identity Provider).
-
Add or modify the following settings in the Dashboard’s web.config file.
-
All the settings must be prefixed with avevanet:. For example, <add key="avevanet:*" value="*" />
Parameter
Description
authenticationProvider
Set as Microsoft Entra ID (case-sensitive).
applicationRootUri
The root URI of AIM’s Dashboard application.
For example: https://sample.example.com/Dashboard
authorityUri
The URI of the Microsoft Entra ID authority.
For example: https://login.microsoftonline.com/
{tenantId}/v2.0
dashboardClientId
Application (client) ID
resourceScope
The resource scope to be passed.
For example: api://
{clientId}/AIM/AVEVA.NET.Workhub
For example:
<add key="avevanet:authenticationProvider" value="AzureAD" />
<add key="avevanet:applicationRootUri" value="
https://sample.example.com/Dashboard " />
<add key="avevanet:authorityUri" value="
https://login.microsoftonline.com/{tenantId}/v2.0" />
<add key="avevanet:dashboardClientId" value="{clientId}" />
<add key="avevanet:resourceScope" value=" api://
{clientId}/AIM/AVEVA.NET.Workhub " />
-
To allow communication with Microsoft Entra ID, in the web.config file under <content-Security-Policy enabled="true"> and then under <connect-src self="true"> add: <add source="https://login.microsoftonline.com/" />.