You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/includes/api-center-portal-user-sign-in.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,12 +6,12 @@ author: dlepow
6
6
7
7
ms.service: azure-api-center
8
8
ms.topic: include
9
-
ms.date: 08/01/2025
9
+
ms.date: 08/05/2025
10
10
ms.author: danlep
11
11
ms.custom: Include file
12
12
---
13
13
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.
15
15
16
16
> [!IMPORTANT]
17
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.
Copy file name to clipboardExpand all lines: articles/api-center/set-up-api-center-portal.md
+17-15Lines changed: 17 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: How to set up the API Center portal, a managed website that enables
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 07/31/2025
7
+
ms.date: 08/05/2025
8
8
ms.update-cycle: 180-days
9
9
ms.author: danlep
10
10
ms.custom:
@@ -43,30 +43,32 @@ After creating the API Center portal app registration, you can customize setting
43
43
3. Confirm that the **Redirect URI** is the value you configured in the app registration.
44
44
4. Select **Save + publish**.
45
45
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**.
46
-
1. On the **API visibility** tab, optionally enable anonymous read access to the portal and add filters for APIs that you want to make discoverable in the portal. Select **Save + publish**. [Learn more about API visibility](#api-visibility)
46
+
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)
47
+
1. On the **Semantic search**, optionally enable [semantic search](#search-with-ai) to enhance API discovery in the portal. Select **Save + publish**.
48
+
1. On the **Metadata** tab, optionally select custom metadata properties that you want to expose in API details and make searchable in the API Center portal. Select **Save**.
49
+
1. Select **Save + publish**.
50
+
51
+
## Access the portal
52
+
53
+
After publishing, you can now access the API Center portal:
47
54
48
-
You can now access the API Center portal:
49
55
* On the portal's **Settings** page, select **View API Center portal** to open the portal in a new tab.
50
56
* Or, enter the following URL in your browser, replacing `<service-name>` and `<location>` with the name of your API center and the location where it's deployed:<br/>
Settings on the **API visibility** page control which APIs are discoverable (visible) to API Center portal users. The API Center portal uses the data plane API to retrieve and display APIs, and by default retrieves all APIs in your API center for [signed-in users](#enable-sign-in-to-portal-by-microsoft-entra-users-and-groups). Visibility settings apply to all users of the API Center portal.
56
-
57
-
#### Anonymous access
59
+
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.
58
60
59
-
Optionally enable anonymous read access to the API Center's APIs in the API Center portal and through the data plane APIs, allowing unauthenticated users to discover the APIs. This setting is useful to make public APIs or MCP servers discoverable.
61
+
## API visibility
60
62
61
-
> [!CAUTION]
62
-
> Enabling anonymous access makes your APIs visible to anyone on the internet. However, users must still sign in to the portal to [test the APIs](#enable-access-to-test-console-for-apis). If you enable anonymous access, consider adding filters to limit the APIs that are discoverable by unauthenticated users.
63
+
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, and by default retrieves all APIs in your API center for signed-in users with Azure RBAC permissions. Visibility settings apply to all users of the API Center portal.
63
64
65
+
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).
64
66
65
-
#### Filter APIs by metadata
67
+
:::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.":::
66
68
67
-
To make only specific APIs visible, add filter conditions for APIs based on built-in or custom API [metadata](metadata.md) properties. For instance, you can choose to display APIs only of certain types (like REST or GraphQL) or based on certain specification formats (such as OpenAPI). Additionally, you can select values of custom metadata properties that categorize your APIs.
69
+
### Anonymous access
68
70
69
-
:::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.":::.
71
+
Optionally enable anonymous read access to the API Center's APIs, allowing 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 and MCP servers in your API center discoverable to unauthenticated users when you [self-host](self-host-api-center-portal.md) the API Center portal.
70
72
71
73
## Enable sign-in to portal by Microsoft Entra users and groups
72
74
@@ -92,7 +94,7 @@ The API Center portal supports and streamlines the work of developers who use an
92
94
93
95
## Search with AI
94
96
95
-
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 namesand descriptions. 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 their names or descriptions don't include those exact words.
97
+
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.
96
98
97
99
> [!TIP]
98
100
> 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.
0 commit comments