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-app-registration.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,18 +22,18 @@ To set up the app registration automatically, follow these steps:
22
22
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
23
23
1. In the left-hand menu, select **API Center portal** > **Settings**.
24
24
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
26
27
27
#### Set up the app registration manually
28
28
29
29
If you want to create the app registration manually, follow these steps:
30
30
31
-
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **App registrations**.
31
+
1. In the [Azure portal](https://portal.azure.com), navigate to **Microsoft Entra ID** > **Manage** > **App registrations**.
32
32
1. Select **+ New registration**.
33
33
1. On the **Register an application** page, set the values as follows:
34
34
35
35
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)**.
36
+
1. Under **Supported account types**, select **Accounts in this organizational directory only (\<Directory name> - Single tenant)**.
37
37
1. In **Redirect URI**, select **Single-page application (SPA)** and set the URI.
38
38
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`.
After you create the API Center portal app registration, you need to configure and publish the API center portal. Complete the following steps in the Azure portal.
36
+
After you create the API Center portal app registration, you need to configure and publish the API Center portal. Complete the following steps in the Azure portal.
37
37
38
38
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
39
-
1. In the left menu, under **API Center portal**, select **Portal settings**.
39
+
1. In the left menu, under **API Center portal**, select **Settings**.
40
40
:::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":::
41
-
1.On the **Identity provider** tab, select **Start set up**. On the screen that appears, do the following:
42
-
1.In**Client ID**, enter the **Application (client) ID** from the app registration you created in the previous section.
43
-
1. Confirm that the **Redirect URI** is the value you configured in the app registration.
44
-
1. Select **Save + publish**.
41
+
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.
42
+
1.On the **Manual** tab, in**Client ID**, enter the **Application (client) ID** from the app registration you created in the previous section.
43
+
3. Confirm that the **Redirect URI** is the value you configured in the app registration.
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 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 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)
47
47
48
48
You can now access the API Center portal:
49
-
* On the **Portal settings** page, select **View API Center portal** to open the portal in a new tab.
49
+
* On the portal's **Settings** page, select **View API Center portal** to open the portal in a new tab.
50
50
* 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/>
API visibility settings 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. Visibility settings apply to all users of the API Center portal.
55
+
Settings on the **API visibility**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
56
57
-
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 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.
57
+
#### Anonymous access
58
+
59
+
Optionally enable anonymous read access to the API Center portal, allowing unauthenticated users to discover the APIs. This setting is useful for public APIs or MCP servers.
60
+
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 try out APIs or view API details. If you enable anonymous access, consider adding filters to limit the APIs that are discoverable by unauthenticated users.
63
+
64
+
65
+
#### Filter APIs by metadata
66
+
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.
58
68
59
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.":::.
0 commit comments