Skip to content

Commit 3bfd9fd

Browse files
author
gitName
committed
refactored to create separate configuration article
1 parent a03c135 commit 3bfd9fd

File tree

8 files changed

+95
-38
lines changed

8 files changed

+95
-38
lines changed

articles/api-center/TOC.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@
7474
items:
7575
- name: Enable API Center portal
7676
href: set-up-api-center-portal.md
77-
- name: Enable API Center portal - VS Code extension
77+
- name: Customize API Center portal
78+
href: customize-api-center-portal.md
79+
- name: Enable API Center portal view - VS Code extension
7880
href: enable-api-center-portal-vs-code-extension.md
7981
- name: Self-host Azure API Center portal
8082
href: self-host-api-center-portal.md
Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
---
2+
title: Customize the API Center Portal
3+
description: Learn about settings you can customize in your Azure API Center portal.
4+
author: dlepow
5+
ms.service: azure-api-center
6+
ms.topic: how-to
7+
ms.date: 08/07/2025
8+
ms.update-cycle: 180-days
9+
ms.author: danlep
10+
ms.custom:
11+
ms.collection: ce-skilling-ai-copilot
12+
# Customer intent: As an API program manager, I want to customize the Azure-managed portal for developers and other API stakeholders in my organization.
13+
---
14+
15+
# Customize your API Center portal
16+
17+
This article explains settings that you can customize in the API Center portal (preview). The API Center portal is an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs in your [API center](overview.md).
18+
19+
To set up the API Center portal for initial use and sign-in, see [Set up the API Center portal](set-up-api-center-portal.md).
20+
21+
> [!NOTE]
22+
> The API Center portal is currently in preview.
23+
24+
## Portal settings page
25+
26+
Configure API Center portal settings in the Azure portal. To access the settings page:
27+
28+
1. Navigate to your API center in the Azure portal.
29+
1. Under **API Center portal**, select **Settings**.
30+
1. Click on the tabs to view and customize the settings.
31+
1. Select **Save + publish** to apply your changes.
32+
33+
:::image type="content" source="media/customize-api-center-portal/configure-portal-settings.png" alt-text="Screenshot of API Center portal settings in the Azure portal." lightbox="media/customize-api-center-portal/configure-portal-settings.png":::
34+
35+
> [!IMPORTANT]
36+
> Select **Save + publish** each time that you make changes to the settings. Until you publish, your changes aren't visible in the API Center portal.
37+
38+
## Site profile
39+
40+
On the **Site profile** tab, optionally provide a custom name that appears in the top bar of the published portal.
41+
42+
:::image type="content" source="media/customize-api-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal.":::
43+
44+
## API visibility
45+
46+
On the **API visibility** tab, control which APIs are discoverable (visible) to API Center portal users. Visibility settings apply to all users of the API Center portal.
47+
48+
The API Center portal uses the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups) to retrieve and display APIs in your API center, and by default shows all APIs for signed-in users with Azure RBAC permissions.
49+
50+
To make only specific APIs visible, add filter conditions for APIs based on built-in properties. For instance, choose to display APIs only of certain types (like REST or GraphQL) or based on certain specification formats (such as OpenAPI).
51+
52+
:::image type="content" source="media/customize-api-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal.":::
53+
54+
## Anonymous access
55+
56+
On the **API visibility** tab, optionally enable anonymous read access to the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups), which allows unauthenticated users to discover the API inventory by direct API calls. For example, enable this setting to make APIs discoverable to unauthenticated users when you [self-host](self-host-api-center-portal.md) the API Center portal.
57+
58+
> [!CAUTION]
59+
> When enabling anonymous access, take care not to expose sensitive information in API definitions or settings.
60+
61+
## Semantic search
62+
63+
If enabled on the **Semantic search** tab, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names, descriptions, and optionally custom metadata. Semantic search is available in the **Standard** plan only.
64+
65+
Users can search for APIs using natural language queries, making it easier to find APIs based on their intent. For example, if a developer searches for "I need an API for inventory management," the portal can suggest relevant APIs, even if the API names or descriptions don't include those exact words.
66+
67+
> [!TIP]
68+
> When using the **Free** plan of Azure API Center, you can [upgrade easily](frequently-asked-questions.yml#how-do-i-upgrade-my-api-center-from-the-free-plan-to-the-standard-plan) to the **Standard** plan to enable full service features including semantic search in the API Center portal.
69+
70+
To use AI-assisted search when signed in to the API Center portal, click in the search box, select **Search with AI**, and enter a query.
71+
72+
:::image type="content" source="media/customize-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal.":::
73+
74+
## Custom metadata
75+
76+
On the **Metadata** tab, optionally select [custom metadata](metadata.md) properties that you want to expose in API details and semantic search.
77+
78+
## Enable access to test console for APIs
79+
80+
You can configure user settings to granularly authorize access to APIs and their specific versions in your API center. For example, configure certain API versions to use API keys for authentication, and create an access policy that permits only specific users to authenticate using those keys.
81+
82+
Access policies also apply to the "Try this API" capability for APIs in the API Center portal, ensuring that only portal users with the appropriate access policy can use the test console for those API versions. [Learn more about authorizing access to APIs](authorize-api-access.md)
83+
84+
## Related content
85+
86+
* [Enable and view Azure API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
130 KB
Loading
30.3 KB
Loading
96.3 KB
Loading
Binary file not shown.

articles/api-center/set-up-api-center-portal.md

Lines changed: 6 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ms.collection: ce-skilling-ai-copilot
1414

1515
# Set up your API Center portal
1616

17-
This article shows you how to set up the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization can use to discover the APIs in your [API center](overview.md). Signed-in users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information is based on Microsoft Entra ID and Azure role-based access control.
17+
This article shows you how to set up the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs in your [API center](overview.md). Signed-in users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information is based on Microsoft Entra ID and Azure role-based access control.
1818

1919
:::image type="content" source="media/self-host-api-center-portal/api-center-portal-signed-in.png" alt-text="Screenshot of the API Center portal after user sign-in.":::
2020

@@ -31,22 +31,20 @@ This article shows you how to set up the *API Center portal* (preview), an Azure
3131

3232
[!INCLUDE [api-center-portal-app-registration](includes/api-center-portal-app-registration.md)]
3333

34-
## Customize and publish the API Center portal
34+
## Configure and publish the API Center portal
3535

36-
After creating the API Center portal app registration, you can customize settings for your API Center portal. Complete the following steps in the Azure portal.
36+
After creating the API Center portal app registration, you can configure settings for your API Center portal. Complete the following steps in the Azure portal.
3737

3838
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
3939
1. In the left menu, under **API Center portal**, select **Settings**.
4040

4141
:::image type="content" source="media/set-up-api-center-portal/configure-portal-settings.png" alt-text="Screenshot of API Center portal settings in the Azure portal." lightbox="media/set-up-api-center-portal/configure-portal-settings.png":::
42+
4243
1. If you set up an app registration manually, on the **Identity provider** tab, select **Start set up**. If you used the quick setup, this step is already complete, and you can continue to settings on other tabs.
4344
1. On the **Manual** tab, in **Client ID**, enter the **Application (client) ID** from the app registration you created in the previous section.
4445
1. Confirm that the **Redirect URI** is the value you configured in the app registration.
4546
1. Select **Save + publish**.
46-
1. On the **Site profile** tab, enter a website name that you want to appear in the top bar of the API Center portal. Select **Save + publish**.
47-
1. On the **API visibility** tab, optionally configure filters for APIs that you want to make discoverable in the portal. Select **Save + publish**. [Learn more about API visibility](#api-visibility)
48-
1. On the **Semantic search** tab. optionally enable [semantic search](#search-with-ai) to enhance API discovery in the portal. Select **Save + publish**.
49-
1. On the **Metadata** tab, optionally select [custom metadata](metadata.md) properties that you want to expose in API details and semantic search. Select **Save**.
47+
1. On the remaining tabs, optionally customize the settings for your API Center portal. For information on the settings, see Customize your API Center portal](customize-api-center-portal.md).
5048
1. Select **Save + publish**.
5149

5250
## Access the portal
@@ -59,28 +57,10 @@ After publishing, you can now access the API Center portal in your browser.
5957

6058
By default, the portal home page is reachable publicly but requires sign-in to access APIs. See [Enable sign-in to portal by Microsoft Entra users and groups](#enable-sign-in-to-portal-by-microsoft-entra-users-and-groups) for details on how to configure user access to the portal.
6159

62-
## API visibility
63-
64-
API visibility settings control which APIs are discoverable (visible) to API Center portal users. The API Center portal uses the [Azure API Center data plane API](/rest/api/dataplane/apicenter/operation-groups) to retrieve and display APIs in your API center, and by default shows all APIs for signed-in users with Azure RBAC permissions. Visibility settings apply to all users of the API Center portal.
65-
66-
To make only specific APIs visible, go to the **API visibility** tab in the API Center portal settings. Here, add filter conditions for APIs based on built-in properties. For instance, choose to display APIs only of certain types (like REST or GraphQL) or based on certain specification formats (such as OpenAPI).
67-
68-
:::image type="content" source="media/set-up-api-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal.":::
69-
70-
### Anonymous access
71-
72-
Optionally enable anonymous read access to the API Center's APIs, which allows unauthenticated users to discover the API inventory by direct calls to the API Center data plane API. For example, enable this setting to make APIs discoverable to unauthenticated users when you [self-host](self-host-api-center-portal.md) the API Center portal.
73-
74-
> [!CAUTION]
75-
> When enabling anonymous access, take care not to expose sensitive information in API definitions or settings.
76-
7760
## Enable sign-in to portal by Microsoft Entra users and groups
7861

7962
[!INCLUDE [api-center-portal-user-sign-in](includes/api-center-portal-user-sign-in.md)]
8063

81-
## Enable access to test console for APIs
82-
83-
You can configure user settings to granularly authorize access to APIs and their specific versions in your API center. For example, configure certain API versions to use API keys for authentication, and create an access policy that permits only specific users to authenticate using those keys. This policy also applies to the "Try this API" capability for APIs in the API Center portal, ensuring that only portal users with the appropriate access policy can use the test console for those API versions. [Learn more about authorizing access to APIs](authorize-api-access.md)
8464

8565
## API discovery and consumption in the API Center portal
8666

@@ -96,20 +76,9 @@ The API Center portal supports and streamlines the work of developers who use an
9676

9777
* **Try out APIs** that support API key authentication or OAuth 2.0 authorization
9878

99-
## Search with AI
100-
101-
In the Standard plan of Azure API Center, the API Center portal supplements basic name-based API search with AI-assisted *semantic search* built on API names, descriptions, and optionally custom metadata. Users can search for APIs using natural language queries, making it easier to find APIs based on their intent. For example, if a developer searches for "I need an API for inventory management," the portal can suggest relevant APIs, even if the API names or descriptions don't include those exact words.
102-
103-
> [!TIP]
104-
> If you're using the Free plan of Azure API Center, you can [upgrade easily](frequently-asked-questions.yml#how-do-i-upgrade-my-api-center-from-the-free-plan-to-the-standard-plan) to the Standard plan to enable full service features including semantic search in the API Center portal.
105-
106-
To use AI-assisted search when signed in to the API Center portal, click in the search box, select **Search with AI**, and enter a query.
107-
108-
:::image type="content" source="media/set-up-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal.":::
109-
110-
[!INCLUDE [api-center-portal-compare-apim-dev-portal](includes/api-center-portal-compare-apim-dev-portal.md)]
11179

11280

11381
## Related content
11482

11583
* [Enable and view Azure API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
84+
* [Customize your API Center portal](customize-api-center-portal.md)

0 commit comments

Comments
 (0)