Management API and portal authentication setup: Microsoft Entra ID

FoundationaLLM comes with out-of-the-box support for Microsoft Entra ID authentication. This means that you can use your Microsoft Entra ID account to log in to the management portal.

Create the Microsoft Entra ID applications

To enable Microsoft Entra ID authentication for the Management API and portal, you need to create two applications in the Microsoft Azure portal:

  • A client application that will be used by the management portal to authenticate users.
  • An API application that will be used by the Management API to authenticate users.

Pre-requisites

Important

Be aware that after completing this registration and the other app registrations in Entra ID as instructed in the docs you will complete the deployment steps outlined at deploy the solution then you will be revisiting your app registrations to complete some of the settings that require the solution to be deployed before the entire app registration is completed successfully.

Setup App Configuration access

  1. Sign in to the Azure portal as at least a Contributor.
  2. Navigate to the Resource Group that was created as part of the deployment.
    Note

    If you performed an Azure Container Apps (ACA) or Azure Kubernetes Service (AKS) deployment, you will see an extra Resource Group that starts with ME_ or MC_ in addition to the Resource Group defined during the deployment. You will need to navigate to the Resource Group that does not start with ME_ or MC_ to access the App Configuration resource.

  3. Select the App Configuration resource and select Configuration explorer to view the values. If you cannot access the configurations, add your user account as an App Configuration Data Owner through Access Control (IAM). You need this role in order to update the configurations as a required part of the authentication setup. To add your user account to the appropriate role, follow the instructions in the Configure access control for services document.

Create the client application

Register the client application in the Microsoft Entra ID admin center

  1. Sign in to the Microsoft Entra ID admin center as at least a Cloud Application Administrator.

  2. Browse to Identity > Applications > App registrations.

    The app registrations menu item in the left-hand menu is highlighted.

  3. On the page that appears, select + New registration.

  4. When the Register an application page appears, enter a name for your application, such as FoundationaLLM-ManagementClient. You should indicate that this is for the management client application by appending -ManagementClient to the name.

  5. Under Supported account types, select Accounts in this organizational directory only.

  6. Select Register.

    The new client app registration form is displayed.

  7. The application's Overview pane displays upon successful registration. Record the Application (client) ID and Directory (tenant) ID to add to your App Configuration settings later.

    The Entra app client ID and Directory ID values are highlighted in the Overview blade.

Add a redirect URI to the client application

  1. Under Manage, select Authentication.

  2. Under Platform configurations, select Add a platform. In the pane that opens, select Single-page application. This is for the Vue.js management application.

  3. Add a Redirect URI under Single-page application for your deployed Vue.js management application. Enter <YOUR_MANAGEMENT_APP_URL>/signin-oidc, replacing <YOUR_MANAGEMENT_APP_URL> with the management UI application URL. For example, it should look something like https://d85a09ce067141d5807a.eastus.aksapp.io/signin-oidc for an AKS deployment, or https://fllmaca002managementuica.graybush-c554b849.eastus.azurecontainerapps.io/signin-oidc for an ACA deployment.

  4. Add a Redirect URI under Single-page application for local development of the management portal Vue.js application: http://localhost:3001/signin-oidc.

    The Authentication left-hand menu item and redirect URIs are highlighted.

If you wish to configure authentication in Postman for executing calls against the Core API, you will need to add a Redirect URI under Mobile and desktop applications for Postman. Enter https://oauth.pstmn.io/v1/callback for the URI. To do this, complete the following steps:

  1. Under Platform configurations, select Add a platform. In the pane that opens, select Mobile and desktop applications.

  2. Enter https://oauth.pstmn.io/v1/callback for the Custom redirect URIs value.

    The Authentication left-hand menu item and redirect URIs are highlighted.

  3. Select Configure to apply the changes.

Implicit grant and hybrid flows for the client application

  1. Check Access tokens and ID tokens under Implicit grant.

  2. Select Configure to apply the changes (if the button is present).

  3. Select Save at the bottom of the page to save the changes.

    Both the Access tokens and ID tokens checkboxes are checked and the Save button is highlighted.

Update the client application manifest

  1. Under Manage, select Manifest.

  2. Locate the accessTokenAcceptedVersion property and set its value to 2.

    The accessTokenAcceptedVersion property is highlighted.

  3. Select Save at the top of the page to save the changes.

Create the API application

Register the API application in the Microsoft Entra ID admin center

  1. Return to the Microsoft Entra ID admin center.

  2. Browse to Identity > Applications > App registrations and select + New registration.

    The app registrations menu item in the left-hand menu is highlighted.

  3. For Name, enter a name for the application. For example, enter FoundationaLLM-Management. Users of the app will see this name, and can be changed later.

  4. Under Supported account types, select Accounts in this organizational directory only.

  5. Select Register.

    The new API app registration form is displayed.

  6. The application's Overview pane displays upon successful registration. Record the Application (client) ID and Directory (tenant) ID to add to your App Configuration settings later.

    The Entra app client ID and Directory ID values are highlighted in the Overview blade.

Implicit grant and hybrid flows for the API application

  1. Select Authentication under Manage in the left-hand menu.

  2. Select + Add a platform under Platform configurations. In the pane that opens, select Web.

  3. Under "Redirect URIs", enter http://localhost and select Configure. Please note that this value is not used in the FoundationaLLM solution, but is required in order to be able to select the access and ID tokens in the next step.

    The redirect URIs value is displayed as described.

  4. Check Access tokens and ID tokens under Implicit grant.

  5. Select Configure to apply the changes.

  6. Select Save at the bottom of the page to save the changes.

    Both the Access tokens and ID tokens checkboxes are checked and the Save button is highlighted.

Expose an API for the API application

  1. Under Manage, select Expose an API > Add a scope. For Application ID URI, accept the default or specify a custom one, then select Save and continue, and then enter the following details:

    • Scope name: Data.Manage
    • Who can consent?: Admins and users
    • Admin consent display name: Manage data on behalf of users
    • Admin consent description: Allows the app to manage data on behalf of the signed-in user.
    • User consent display name: Manage data on behalf of the user
    • User consent description: Allows the app to manage data on behalf of the signed-in user.
    • State: Enabled

  2. Select Add scope to complete the scope addition.

    The Add a scope form is displayed as described in the bulleted list above.

  3. Copy the Scope name value to add to your App Configuration settings later. For example, it should look something like api://c79a09ce067141d5832b/Data.Manage.

    The new scope name is displayed with the Copy button highlighted.

Add authorized client application

  1. While still in the Expose an API section, select + Add a client application.

  2. Paste the Application (client) ID of the client application that you created earlier.

  3. Check the Data.Manage authorized scope that you created.

  4. Select Add application to complete the client application addition.

    The add a client application form is displayed as described.

Update the API application manifest

  1. Under Manage, select Manifest.

  2. Locate the accessTokenAcceptedVersion property and set its value to 2.

    The accessTokenAcceptedVersion property is highlighted.

  3. Select Save at the top of the page to save the changes.

Add API permissions for the client application

  1. Browse to Identity > Applications > App registrations.

    The app registrations menu item in the left-hand menu is highlighted.

  2. Select the FoundationaLLM-ManagementClient application that you created earlier.

  3. Select API permissions.

  4. Select + Add a permission under the "Configured permissions" section.

  5. In the "Request API permissions" pan, select the My APIs tab, then select the FoundationaLLM-Management API application.

    The FoundationaLLM API is selected under My APIs.

  6. Select the Data.Manage scope that you created earlier, then select Add permissions.

    The Data.Manage scope is selected.

The client application's configured permissions should now look like the following:

The client application's configured permissions are displayed.

Update App Configuration settings

  1. Sign in to the Azure portal as at least a Contributor.

  2. Navigate to the resource group that was created as part of the deployment.

  3. Select the App Configuration resource and select Configuration explorer to view the values.

  4. Enter entra in the search box to filter the results.

  5. Check the box next to Key in the header to select all items.

  6. Select Edit to open a JSON editor for the selected items.

    The configuration settings are filtered by entra and all items are selected.

  7. Replace the values for the following settings with the values that you recorded earlier:

    • FoundationaLLM:Management:Entra:ClientId: The Application (client) ID of the client application that you created earlier.
    • FoundationaLLM:Management:Entra:Scopes: The fully-qualified scopes path for the API application that you created earlier. For example, it should look something like api://d85a09ce067141d5807a/Data.Manage.
    • FoundationaLLM:Management:Entra:TenantId: The Directory (tenant) ID of the client application that you created earlier.
    • FoundationaLLM:ManagementAPI:Entra:ClientId: The Application (client) ID of the API application that you created earlier.
    • FoundationaLLM:ManagementAPI:Entra:TenantId: The Directory (tenant) ID of the API application that you created earlier.

  8. Validate the following values while reviewing the settings:

    • FoundationaLLM:Management:Entra:CallbackPath: Should be /signin-oidc.
    • FoundationaLLM:Management:Entra:Instance: Should be https://login.microsoftonline.com/.
    • FoundationaLLM:ManagementAPI:Entra:Instance: Should be https://login.microsoftonline.com/.
    • FoundationaLLM:ManagementAPI:Entra:Scopes: Should be Data.Manage.

  9. Select Apply to save the changes.

Next steps

Now that Entra authentication is fully configured, restart the Management API and management portal applications to apply the changes. Navigate to your management portal application or refresh the page if it is already open. It should automatically prompt you to sign in with your Microsoft Entra ID account.

Edit this page