Skip to content

api-center-portal-app-registration.md

Latest commit

 

History

History
57 lines (39 loc) · 3.09 KB

api-center-portal-app-registration.md

File metadata and controls

57 lines (39 loc) · 3.09 KB
title Include file
description Include file
services api-center
ms.service azure-api-center
ms.topic include
ms.date 02/25/2026
ms.custom Include file

To configure Microsoft Entra ID as an identity provider, first configure an app registration in your Microsoft Entra ID tenant. The app registration enables the API Center portal to access data from your API center on behalf of a signed-in user.

API Center can set up the app registration automatically, or you can create the app registration manually.

Set up the app registration automatically (recommended)

To set up the app registration automatically, follow these steps:

  1. In the Azure portal, go to your API center.

  2. In the sidebar menu, select API Center portal > Settings.

  3. On the Access tab, select Configure Entra ID. :::image type="content" source="../media/set-up-api-center-portal/configure-access-entra-id.png" alt-text="Screenshot showing configuration of Entra ID in the portal.":::

  4. On the Set up user sign-in with Microsoft Entra ID page, select Configure.

  5. On the Access tab, select Save + publish.

If you need to access the app registration later, you can find it in the portal under App registrations. The application is named with the following format: <api-center-name>-apic-aad.

Set up the app registration manually

If you want to create the app registration manually, follow these steps:

  1. In the Azure portal, go to Microsoft Entra ID > Manage > App registrations.

  2. Select + New registration.

  3. On the Register an application page, set the values as follows:

    1. Set Name to a meaningful name such as api-center-portal
    2. Under Supported account types, select Accounts in this organizational directory only (<Directory name> - Single tenant).
    3. In Redirect URI, select Single-page application (SPA) and set the URI. Enter the URI of your API Center portal deployment, in the following form: https://<service-name>.portal.<location>.azure-apicenter.ms. Replace <service name> and <location> with the name of your API center and the location where it's deployed, Example: https://myapicenter.portal.eastus.azure-apicenter.ms.
    4. Select Register.

Configure additional redirect URIs for VS Code extension

When enabling the API Center portal view in the Visual Studio Code extension for API Center, also configure the following redirect URIs in the app registration:

  1. In the Azure portal, navigate to your app registration.

  2. On the Manage > Authentication page, select Add a platform and select Mobile and desktop applications.

  3. Configure the following three custom redirect URIs:
    https://vscode.dev/redirect
    http://localhost
    ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>

    Replace <application-client-id> with the application (client) ID of this app. You can find this value on the Overview page of the app registration.