Skip to content

Commit 486d0aa

Browse files
committed
docs: update the api center portal setup steps
1 parent 97359f8 commit 486d0aa

File tree

5 files changed

+22
-81
lines changed

5 files changed

+22
-81
lines changed

articles/api-center/enable-platform-api-catalog-vscode-extension.md renamed to articles/api-center/enable-api-center-portal-vscode-extension.md

Lines changed: 20 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Enable platform API catalog - Azure API Center - VS Code extension
2+
title: Enable platform API Center Portal - Azure API Center - VS Code extension
33
description: Enable enterprise developers to view the enterprise's platform API catalog including API definitions using the Visual Studio Code Extension for Azure API Center.
44
author: dlepow
55
ms.service: azure-api-center
@@ -10,17 +10,15 @@ ms.custom:
1010
# Customer intent: As an API program manager, I want to enable an API catalog so that app developers in my organization can discover and consume the APIs in my organization's API center without needing to manage the API inventory itself.
1111
---
1212

13-
# Enable and view Azure API Center platform API catalog
13+
# Enable and view Azure API Center Portal
1414

15-
This article shows how to provide enterprise developers access to the Azure API Center platform API catalog (preview) in the Visual Studio Code extension for [Azure API Center](overview.md). Using the platform API catalog, developers can discover APIs in your Azure API center, view API definitions, and optionally generate API clients when they don't have access to manage the API center itself or add APIs to the inventory. Access to the platform API catalog is managed using Microsoft Entra ID and Azure role-based access control.
15+
This article shows how to provide enterprise developers access to the Azure API Center Portal in the Visual Studio Code extension for [Azure API Center](overview.md). Using the platform API catalog, developers can discover APIs in your Azure API center, view API definitions, and optionally generate API clients when they don't have access to manage the API center itself or add APIs to the inventory. Access to the API Center Portal is managed using Microsoft Entra ID and Azure role-based access control.
1616

1717
> [!TIP]
1818
> The Visual Studio Code extension provides more features for API developers who have permissions to manage an Azure API center. For example, API developers can register APIs in the API center directly or using CI/CD pipelines. [Learn more](build-register-apis-vscode-extension.md)
1919
2020
## Prerequisites
2121

22-
### For API center administrators
23-
2422
* 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).
2523

2624
* 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.
@@ -29,76 +27,27 @@ This article shows how to provide enterprise developers access to the Azure API
2927

3028
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
3129

32-
> [!IMPORTANT]
33-
> Currently, access to the platform API catalog is available only in the extension's pre-release version. [!INCLUDE [vscode-extension-prerelease-features](includes/vscode-extension-prerelease-features.md)]
3430

3531
The following Visual Studio Code extension is optional:
3632

3733
* [Microsoft Kiota extension](https://marketplace.visualstudio.com/items?itemName=ms-graph.kiota) - to generate API clients
3834

39-
## Steps for API center administrators to enable access to catalog
35+
## Steps for API center administrators to enable access to API Center Portal
4036

41-
The following sections provide steps for API center administrators to enable enterprise developers to access the platform API catalog.
37+
The following sections provide steps for API center administrators to enable enterprise developers to access the API Center Portal.
4238

4339
### Create Microsoft Entra app registration
40+
[!INCLUDE [api-center-portal-app-registration](includes/api-center-portal-app-registration.md)]
4441

45-
First, configure an app registration in your Microsoft Entra ID tenant. The app registration enables the Visual Studio Code extension for Azure API Center to access the platform API catalog on behalf of a signed-in user.
46-
47-
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
48-
1. Select **+ New registration**.
49-
1. On the **Register an application** page, set the values as follows:
50-
51-
* Set **Name** to a meaningful name such as *platform-api-catalog*
52-
* Under **Supported account types**, select **Accounts in this organizational directory (Single tenant)**.
53-
* In **Redirect URI**, select **Single-page application (SPA)** and set the URI to the runtime URI of your API center. For example, `https://<service name>.data.<region>.azure-apicenter.ms`. Example: `https://contoso-apic.data.eastus.azure-apicenter.ms`.
54-
* Select **Register**.
55-
56-
> [!TIP]
57-
> You can use the same app registration for access to more API centers. In **Redirect URI**, continue to add redirect URIs for other API centers that you want to appear in the platform API catalog.
58-
1. On the **Overview** page, copy the **Application (client) ID** and the **Directory (tenant) ID**. You set these values later when you connect to the API center from the Visual Studio Code extension.
59-
1. In the left menu, under **Manage**, select **Authentication** > **+ Add a platform**.
60-
1. On the **Configure platforms** page, select **Mobile and desktop applications**.
61-
1. On the **Configure Desktop + devices** page, enter the following redirect URI and select **Configure**:
62-
63-
`https://vscode.dev/redirect` , `http://localhost` and `ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>`
64-
65-
1. In the left menu, under **Manage**, select **API permissions** > **+ Add a permission**.
66-
1. On the **Request API permissions** page, do the following:
67-
1. Select the **APIs my organization uses** tab.
68-
1. Search for and select **Azure API Center**. You can also search for and select application ID `c3ca1a77-7a87-4dba-b8f8-eea115ae4573`.
69-
1. In **Select permissions** page, select **user_impersonation**.
70-
1. Select **Add permissions**.
71-
72-
The Azure API Center permissions appear under **Configured permissions**.
42+
### Enable sign-in to API Center Portal by Microsoft Entra users and groups
7343

74-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/configure-app-permissions.png" alt-text="Screenshot of required permissions in Microsoft Entra ID app registration in the portal." :::
44+
Enterprise developers must sign in with a Microsoft account to see the API Center Portal for your API center. If needed, [add or invite developers](/entra/external-id/b2b-quickstart-add-guest-users-portal) to your Microsoft Entra tenant.
7545

76-
### Enable sign-in to platform API catalog by Microsoft Entra users and groups
77-
78-
Enterprise developers must sign in with a Microsoft account to see the platform API catalog for your API center. If needed, [add or invite developers](/entra/external-id/b2b-quickstart-add-guest-users-portal) to your Microsoft Entra tenant.
79-
80-
Then, to enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your tenant, scoped to your API center.
81-
82-
> [!IMPORTANT]
83-
> By default, you and other administrators of the API center don't have access to APIs in the API Center extension's platform API catalog. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
84-
85-
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:
86-
87-
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
88-
1. In the left menu, select **Access control (IAM)** > **+ Add role assignment**.
89-
1. In the **Add role assignment** pane, set the values as follows:
90-
* On the **Role** page, search for and select **Azure API Center Data Reader**. Select **Next**.
91-
* On the **Members** page, In **Assign access to**, select **User, group, or service principal** > **+ Select members**.
92-
* On the **Select members** page, search for and select the users or groups to assign the role to. Click **Select** and then **Next**.
93-
* Review the role assignment, and select **Review + assign**.
94-
1. Repeat the preceding steps to enable sign-in to the platform API catalog for more API centers.
95-
96-
> [!NOTE]
97-
> 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).
98-
99-
## Steps for enterprise developers to access the platform API catalog
46+
[!INCLUDE [api-center-portal-user-sign-in](includes/api-center-portal-user-sign-in.md)]
47+
### For API center administrators
48+
## Steps for enterprise developers to access the API Center Portal
10049

101-
Developers can follow these steps to connect and sign in to view a platform API catalog using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
50+
Developers can follow these steps to connect and sign in to view a API Center Portal using the Visual Studio Code extension. Settings to connect to the API center need to be provided by the API center administrator.
10251

10352
### Connect to an API center
10453

@@ -118,21 +67,21 @@ Developers can follow these steps to connect and sign in to view a platform API
11867
> An API center administrator needs to provide these connection details to developers, or provide a direct link in the following format:
11968
> `vscode://apidev.azure-api-center?clientId=<Client ID>&tenantId=<tenant ID>&runtimeUrl=<service-name>.data.<region>.azure-apicenter.ms`
12069
121-
After you connect to the API center, the name of the API center appears in the API Center platform API catalog.
70+
After you connect to the API center, the name of the API center appears in the API Center Portal.
12271

12372
1. To view the APIs in the API center, under the API center name, select **Sign in to Azure**. Sign-in is allowed with a Microsoft account that is assigned the **Azure API Center Data Reader** role in the API center.
12473

125-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center platform API catalog in VS Code extension." :::
74+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-initial.png" alt-text="Screenshot of API Center Portal in VS Code extension." :::
12675

12776
1. After signing in, select **APIs** to list the APIs in the API center. Expand an API to explore its versions and definitions.
12877

129-
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center platform API catalog with APIs in VS Code extension." :::
78+
:::image type="content" source="media/enable-platform-api-catalog-vscode-extension/api-center-pane-apis.png" alt-text="Screenshot of API Center Portal with APIs in VS Code extension." :::
13079

13180
1. Repeat the preceding steps to connect to more API centers, if access is configured.
13281

133-
### Discover and consume APIs in the catalog
82+
### Discover and consume APIs in the API Center Portal
13483

135-
The platform API catalog helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the platform API catalog:
84+
The API Center Portal helps enterprise developers discover API details and start API client development. Developers can access the following features by right-clicking on an API definition in the API Center Portal:
13685

13786
* **Export API specification document** - Export an API specification from a definition and then download it as a file
13887
* **Generate API client** - Use the Microsoft Kiota extension to generate an API client for their favorite language
@@ -144,15 +93,15 @@ The platform API catalog helps enterprise developers discover API details and st
14493

14594
### Error: Cannot read properties of undefined (reading 'nextLink')
14695

147-
Under certain conditions, a user might encounter the following error message after signing into the API Center platform API catalog and expanding the APIs list for an API center:
96+
Under certain conditions, a user might encounter the following error message after signing into the API Center Portal and expanding the APIs list for an API center:
14897

14998
`Error: Cannot read properties of undefined (reading 'nextLink')`
15099

151-
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center platform API catalog in the Visual Studio Code extension.
100+
Check that the user is assigned the **Azure API Center Data Reader** role in the API center. If necessary, reassign the role to the user. Then, refresh the API Center Portal in the Visual Studio Code extension.
152101

153102
### Unable to sign in to Azure
154103

155-
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the platform API catalog, there might be a problem with the configuration of the connection.
104+
If users who have been assigned the **Azure API Center Data Reader** role can't complete the sign-in flow after selecting **Sign in to Azure** in the API Center Portal, there might be a problem with the configuration of the connection.
156105

157106
Check the settings in the app registration you configured in Microsoft Entra ID. Confirm the values of the application (client) ID and the directory (tenant) ID in the app registration and the runtime URL of the API center. Then, set up the connection to the API center again.
158107

articles/api-center/includes/api-center-portal-app-registration.md

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,5 @@ First configure an app registration in your Microsoft Entra ID tenant. The app r
2424
1. In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
2525
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`.
2626
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":::
27+
1. Turn into **Authentication** page, click **Add a platform** and select the **Mobile and desktop applications**, add following three Redirect URIs into this section: `https://vscode.dev/redirect`, `http://localhost`, and `ms-appx-web://Microsoft.AAD.BrokerPlugin/<application-client-id>`. Replace `<application-client-id>` with this AAD App.
28+
1. On the **Overview** page, copy the **Application (client) ID**. You set this value when you publish the portal.
-40.1 KB
Loading
-29.1 KB
Loading

0 commit comments

Comments
 (0)