Skip to content

Commit 8501bb7

Browse files
Merge pull request #304043 from MicrosoftDocs/main
Auto Publish – main to live - 2025-08-10 11:00 UTC
2 parents 9e7ac89 + 6fffb6a commit 8501bb7

14 files changed

+127
-45
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

articles/api-center/authorize-api-access.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ You can manage access by specific users or groups in your organization to an API
174174
You can use the API Center portal to test an API that you configured for authentication and user access.
175175

176176
> [!TIP]
177-
> In addition to enabling specific users to test specific APIs in the API Center portal, you can configure [visibility settings](set-up-api-center-portal.md#api-visibility) for APIs. Visibility settings in the portal control the APIs that appear for all signed-in users.
177+
> In addition to enabling specific users to test specific APIs in the API Center portal, you can configure [visibility settings](customize-api-center-portal.md#api-visibility) for APIs. Visibility settings in the portal control the APIs that appear for all signed-in users.
178178
179179
1. In the [portal](https://azure.microsoft.com), navigate to your API center.
180180
1. In the left menu, under **API Center Portal**, select **Portal settings**.
Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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+
* [Set up the API Center portal](set-up-api-center-portal.md)
87+
* [Enable and view Azure API Center portal in Visual Studio Code](enable-api-center-portal-vs-code-extension.md)
88+
* [Self-host the API Center portal](self-host-api-center-portal.md)
89+

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: dlepow
66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 05/28/2025
9+
ms.date: 08/08/2025
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
@@ -22,18 +22,20 @@ To set up the app registration automatically, follow these steps:
2222
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
2323
1. In the left-hand menu, select **API Center portal** > **Settings**.
2424
1. On the **Identity provider** tab, select **Start set up**.
25-
1. Select **Save + publish**.
25+
1. On the **Quick setup** tab, select **Save + publish**.
26+
27+
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**.
2628

2729
#### Set up the app registration manually
2830

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

31-
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
33+
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **Manage** > **App registrations**.
3234
1. Select **+ New registration**.
3335
1. On the **Register an application** page, set the values as follows:
3436

3537
1. Set **Name** to a meaningful name such as *api-center-portal*
36-
1. Under **Supported account types**, select **Accounts in this organizational directory (Single tenant)**.
38+
1. Under **Supported account types**, select **Accounts in this organizational directory only (\<Directory name> - Single tenant)**.
3739
1. In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
3840
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`.
3941
1. Select **Register**.

articles/api-center/includes/api-center-portal-user-sign-in.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ author: dlepow
66

77
ms.service: azure-api-center
88
ms.topic: include
9-
ms.date: 03/04/2025
9+
ms.date: 08/05/2025
1010
ms.author: danlep
1111
ms.custom: Include file
1212
---
1313

14-
To enable sign-in, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
14+
To enable sign-in to the API Center portal to access APIs, assign the **Azure API Center Data Reader** role to users or groups in your organization, scoped to your API center.
1515

1616
> [!IMPORTANT]
17-
> 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.
17+
> By default, you and other administrators of the API center must sign-in to access APIs in the API Center portal. Be sure to assign the **Azure API Center Data Reader** role to yourself and other administrators.
1818
1919
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:
2020

59.7 KB
Loading
130 KB
Loading
30.3 KB
Loading
96.3 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)