Skip to content

Commit ebca7df

Browse files
authored
Merge pull request #295745 from dlepow/apicport
[APIC] Managed API Center portal
2 parents ca22829 + a741e42 commit ebca7df

17 files changed

+357
-200
lines changed

articles/api-center/TOC.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,12 +68,14 @@
6868
href: set-up-notification-workflow.md
6969
- name: API discovery and consumption
7070
items:
71+
- name: Enable API Center portal
72+
href: set-up-api-center-portal.md
73+
- name: Self-host Azure API Center portal
74+
href: self-host-api-center-portal.md
7175
- name: Discover and consume APIs - VS Code extension
7276
href: discover-apis-vscode-extension.md
7377
- name: Enable platform API catalog - VS Code extension
7478
href: enable-platform-api-catalog-vscode-extension.md
75-
- name: Self-host Azure API Center portal
76-
href: enable-api-center-portal.md
7779
- name: Check API calls use minimal permissions with Dev Proxy
7880
href: check-minimal-api-permissions-dev-proxy.md
7981
- name: API center management and operations

articles/api-center/enable-api-center-portal.md

Lines changed: 0 additions & 194 deletions
This file was deleted.
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
services: api-center
5+
author: dlepow
6+
7+
ms.service: azure-api-center
8+
ms.topic: include
9+
ms.date: 03/04/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
## Create Microsoft Entra app registration
15+
16+
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.
17+
18+
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
19+
1. Select **+ New registration**.
20+
1. On the **Register an application** page, set the values as follows:
21+
22+
1. Set **Name** to a meaningful name such as *api-center-portal*
23+
1. Under **Supported account types**, select **Accounts in this organizational directory (Single tenant)**.
24+
1. In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
25+
Enter the URI of your API Center portal deployment, in the following form: `https://<service-name>.portal.<location>.azure-api-center.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-api-center.ms`.
26+
1. Select **Register**.
27+
1. On the **Overview** page, copy the **Application (client) ID**. You set this value when you publish the portal.
28+
29+
1. On the **API permissions** page, select **+ Add a permission**.
30+
1. On the **Request API permissions** page, select the **APIs my organization uses** tab. Search for and select **Azure API Center**. You can also search for and select application ID `c3ca1a77-7a87-4dba-b8f8-eea115ae4573`.
31+
1. On the **Request permissions** page, select **user_impersonation**.
32+
1. Select **Add permissions**.
33+
34+
The Azure API Center permissions appear under **Configured permissions**.
35+
36+
:::image type="content" source="media/api-center-portal-app-registration/configure-app-permissions.png" alt-text="Screenshot of required permissions in Microsoft Entra ID app registration in the portal." lightbox="media/api-center-portal-app-registration/configure-app-permissions.png":::
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
services: api-center
5+
author: dlepow
6+
7+
ms.service: azure-api-center
8+
ms.topic: include
9+
ms.date: 03/05/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
## API Management and API Center portals
15+
16+
The [Azure API Management](../../api-management/api-management-key-concepts.md) and [Azure API Center](../overview.md) services both provide portals for developers to discover and consume APIs:
17+
18+
* The *API Management developer portal* allows users to find managed APIs, learn how to use them, request access, and test them.
19+
* The *API Center portal* (preview) is a multi-gateway portal where users can discover and filter the organization's complete API inventory.
20+
21+
While the two portals share some features, they also have distinct differences. The following table compares current capabilities to help determine which portal to use. Some organizations may prefer one portal, while others may need both.
22+
23+
| Feature | API Management developer portal | API Center portal (preview) |
24+
| --- | --- | --- |
25+
| Search and filter API inventory | API Management instance only | All APIs<sup>1</sup> |
26+
| View API details and definitions | ✔️ | ✔️ |
27+
| View API documentation | ✔️ | ✔️ |
28+
| Customize with branding | ✔️ | Name only |
29+
| Integrate with Microsoft Entra ID | ✔️ | ✔️ |
30+
| Add custom widgets | ✔️ ||
31+
| Customize with WordPress | ✔️ ||
32+
| Test APIs in test console | ✔️ ||
33+
| Subscribe to APIs | ✔️ ||
34+
| View API usage analytics | ✔️ ||
35+
36+
<sup>1</sup> The API Center portal can contain all APIs in your organization, including those managed in Azure API Management and other platforms, as well as unmanaged APIs and APIs under development.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
services: api-center
5+
author: dlepow
6+
7+
ms.service: azure-api-center
8+
ms.topic: include
9+
ms.date: 03/04/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
## Prerequisites
15+
16+
* An API center in your Azure subscription. If you haven't created one already, see [Quickstart: Create your API center](../set-up-api-center.md).
17+
18+
* Permissions to create an app registration in a Microsoft Entra tenant associated with your Azure subscription, and permissions to grant access to data in your API center.
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Include file
3+
description: Include file
4+
services: api-center
5+
author: dlepow
6+
7+
ms.service: azure-api-center
8+
ms.topic: include
9+
ms.date: 03/04/2025
10+
ms.author: danlep
11+
ms.custom: Include file
12+
---
13+
14+
## Enable sign-in to portal by Microsoft Entra users and groups
15+
16+
Users must sign in to see the APIs in your API center. To enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
17+
18+
> [!IMPORTANT]
19+
> By default, you and other administrators of the API center don't have access to APIs in the API Center portal. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
20+
21+
For detailed prerequisites and steps to assign a role to users and groups, see [Assign Azure roles using the Azure portal](../../role-based-access-control/role-assignments-portal.yml). Brief steps follow:
22+
23+
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
24+
1. In the left menu, select **Access control (IAM)** > **+ Add role assignment**.
25+
1. In the **Add role assignment** pane, set the values as follows:
26+
1. On the **Role** page, search for and select **Azure API Center Data Reader**. Select **Next**.
27+
1. On the **Members** page, In **Assign access to**, select **User, group, or service principal** > **+ Select members**.
28+
1. On the **Select members** page, search for and select the users or groups to assign the role to. Click **Select** and then **Next**.
29+
1. Review the role assignment, and select **Review + assign**.
30+
31+
> [!NOTE]
32+
> To streamline access configuration for new users, we recommend that you assign the role to a Microsoft Entra group and configure a dynamic group membership rule. To learn more, see [Create or update a dynamic group in Microsoft Entra ID](/entra/identity/users/groups-create-rule).
33+
34+
After you configure access to the portal, configured users can sign in to the portal and view the APIs in your API center.
35+
36+
> [!NOTE]
37+
> The first user to sign in to the portal is prompted to consent to the permissions requested by the API Center portal app registration. Thereafter, other configured users aren't prompted to consent.

articles/api-center/index.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -71,8 +71,8 @@ landingContent:
7171
linkLists:
7272
- linkListType: how-to-guide
7373
links:
74-
- text: Self-host Azure API Center portal
75-
url: enable-api-center-portal.md
74+
- text: Set up Azure API Center portal
75+
url: set-up-api-center-portal.md
7676
# Card
7777
- title: Related service
7878
linkLists:
207 KB
Loading

0 commit comments

Comments
 (0)