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
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,13 +14,13 @@ ms.custom: Include file
14
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
-
> *The API center owner is automatically assigned the **Azure API Center Data Reader** role when Microsoft Entra ID is configured for the portal.
18
-
> * Be sure to assign the **Azure API Center Data Reader** role to other administrators.
17
+
> *When Microsoft Entra ID is configured for portal access, the user who configures the portal is automatically assigned the **Azure API Center Data Reader** role.
18
+
> * Be sure to assign the **Azure API Center Data Reader** role to other administrators of the API center.
19
19
20
20
For detailed prerequisites and steps to assign a role to users and groups, see [Assign Azure roles using the Azure portal](/azure/role-based-access-control/role-assignments-portal). Brief steps follow:
21
21
22
-
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
23
-
1. In the left menu, select **Access control (IAM)** > **+ Add role assignment**.
22
+
1. In the [Azure portal](https://portal.azure.com), go to your API center.
23
+
1. In the sidebar menu, select **Access control (IAM)** > **+ Add role assignment**.
24
24
1. In the **Add role assignment** pane, set the values as follows:
25
25
1. On the **Role** page, search for and select **Azure API Center Data Reader**. Select **Next**.
26
26
1. On the **Members** page, In **Assign access to**, select **User, group, or service principal** > **+ Select members**.
@@ -30,7 +30,7 @@ For detailed prerequisites and steps to assign a role to users and groups, see [
30
30
> [!NOTE]
31
31
> 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).
32
32
33
-
After you configure access to the portal, configured users can sign in to the portal and view the APIs in your API center.
33
+
After you configure access to the portal, users can sign in to the portal and view the APIs in your API center.
34
34
35
35
> [!NOTE]
36
36
> The first user to sign in to the portal is prompted to consent to the permissions requested by the API Center portal app registration. Thereafter, other configured users aren't prompted to consent.
Copy file name to clipboardExpand all lines: articles/api-center/set-up-api-center-portal.md
+26-33Lines changed: 26 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,21 +14,21 @@ ms.collection:
14
14
15
15
# Set up and customize your API Center portal
16
16
17
-
This article shows you how to set up and customize the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIsin 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 and customize the *API Center portal* (preview), an Azure-managed website that developers and other stakeholders in your organization use to discover the APIs, MCP servers, and related assets in your [API center](overview.md). Portal users can browse and filter APIs and view API details such as API definitions and documentation. User access to API information can be configured with Microsoft Entra ID and Azure role-based access control.
18
18
19
19
:::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.":::
20
20
21
21
> [!NOTE]
22
22
> The API Center portal is currently in preview.
23
23
24
24
> [!TIP]
25
-
> Both Azure API Management and Azure API Center provide API portal experiences for developers. [Compare the portals](#api-management-and-api-center-portals)
25
+
> Both Azure API Management and Azure API Center provide API portal experiences for developers. [Compare the portals](#api-management-and-api-center-portals).
To publish your API Center portal, you can either set up Microsoft Entra ID as and identity provider or allow anonymous access.
31
+
First, choose how you want users to access the API Center portal. You can set up Microsoft Entra ID as an identity provider or allow anonymous access.
32
32
33
33
### Option 1: Configure Microsoft Entra ID authentication for the portal (recommended)
34
34
@@ -39,34 +39,24 @@ To publish your API Center portal, you can either set up Microsoft Entra ID as a
39
39
To set up the API Center portal with anonymous access enabled, follow these steps.
40
40
41
41
> [!CAUTION]
42
-
> Configuring anonymous access allows anyone to view the APIs in your API center without signing in. Take care not to expose sensitive information in API definitions or settings.
42
+
> If you configure anonymous access, anyone can view the APIs in your API center without signing in. Don't expose sensitive information in API definitions or settings.
43
43
44
44
1. In the [Azure portal](https://portal.azure.com), go to your API center.
45
45
1. In the sidebar menu, select **API Center portal** > **Settings**.
46
46
1. On the **Access** tab, select **Allow anonymous access**.
47
47
48
-
:::image type="content" source="../media/set-up-api-center-portal/configure-access-anonymous.png" alt-text="Screenshot showing configuration of anonymous access in the portal.":::
48
+
:::image type="content" source="media/set-up-api-center-portal/configure-access-anonymous.png" alt-text="Screenshot showing configuration of anonymous access in the portal.":::
49
49
1. To configure access, select **Confirm and Enable**.
50
50
51
-
## Publish the API Center portal
52
-
53
-
After configuring access to the API Center portal, publish your API Center portal. Complete the following steps in the Azure portal.
54
-
55
-
1. In the [Azure portal](https://portal.azure.com), navigate to your API center.
56
-
1. In the left menu, under **API Center portal**, select **Settings**.
57
-
1. Select **Save + publish**.
58
-
59
-
:::image type="content" source="media/set-up-api-center-portal/save-and-publish.png" alt="Screenshot of Save + Publish button in the Azure portal.":::
60
-
61
51
## Access the portal
62
52
63
-
After publishing, you can access the API Center portal in your browser.
53
+
After configuring access, go to the API Center portal in your browser.
64
54
65
55
* On the portal's **Settings** page, select **View API Center portal** to open the portal in a new tab.
66
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/>
By default, the portal home page is reachable publicly. If Microsoft Entra ID is configured for access, users must 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.
59
+
By default, the portal home page is reachable publicly. If Microsoft Entra ID is configured for access, a **Sign-in** page appears in the portal, and users must signin 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.
70
60
71
61
## Enable sign-in to portal by Microsoft Entra users and groups
72
62
@@ -77,60 +67,63 @@ By default, the portal home page is reachable publicly. If Microsoft Entra ID is
77
67
The following sections show you how to customize the API Center portal experience for users. For more extensive customization, you can also choose to [self-host the API Center portal](self-host-api-center-portal.md).
78
68
79
69
> [!IMPORTANT]
80
-
> 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.
70
+
> Select **Save + publish** on the API Center portal's **Settings** page each time that you make changes to the settings. Until you publish, your changes aren't visible in the API Center portal.
71
+
> :::image type="content" source="media/set-up-api-center-portal/save-and-publish.png" alt="Screenshot of Save + Publish button in the Azure portal.":::
81
72
82
73
### Site profile
83
74
84
75
On the **Site profile** tab of the API Center portal settings, optionally provide a custom name that appears in the top bar of the published portal.
85
76
86
-
:::image type="content" source="media/set-up-apic-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal.":::
77
+
:::image type="content" source="media/set-up-api-center-portal/custom-name.png" alt-text="Screenshot of custom name in API Center portal.":::
87
78
88
79
## API visibility
89
80
90
81
On the **Visibility** tab, control which APIs are discoverable (visible) to API Center portal users. Visibility settings apply to all users of the API Center portal.
91
82
92
-
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.
83
+
> [!NOTE]
84
+
> 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 users with access.
85
+
>
93
86
94
-
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).
87
+
To make only specific APIs visible, add filter conditions for APIs based on built-in properties. For example, choose to display APIs only of certain types, like REST or GraphQL, or based on certain specification formats, such as OpenAPI.
95
88
96
-
:::image type="content" source="media/set-up-apic-center-portal/add-visibility-condition.png" alt-text="Screenshot of adding API visibility conditions in the portal.":::
89
+
:::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.":::
97
90
98
91
## Semantic search
99
92
100
-
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.
93
+
If you enable semantic search 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.
101
94
102
-
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.
95
+
Users can search for APIs by 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.
103
96
104
97
> [!TIP]
105
98
> When using the **Free** plan of Azure API Center, you can [upgrade](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.
106
99
107
-
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.
100
+
To use AI-assisted search when signed in to the API Center portal, select the search box, choose**Search with AI**, and enter a query.
108
101
109
-
:::image type="content" source="media/set-up-apic-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal.":::
102
+
:::image type="content" source="media/set-up-api-center-portal/semantic-search.png" alt-text="Screenshot of semantic search results in API Center portal.":::
110
103
111
104
## Custom metadata
112
105
113
106
On the **Metadata** tab, optionally select [custom metadata](metadata.md) properties that you want to expose in API details and semantic search.
114
107
115
108
## Enable access to test console for APIs
116
109
117
-
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.
110
+
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 by using those keys.
118
111
119
-
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)
112
+
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).
120
113
121
114
## API discovery and consumption in the API Center portal
122
115
123
116
The API Center portal supports and streamlines the work of developers who use and create APIs within your organization. Signed-in users can:
124
117
125
-
***Search for APIs** by name or using[AI-assisted semantic search](customize-api-center-portal.md#semantic-search)
118
+
***Search for APIs** by name or use[AI-assisted semantic search](customize-api-center-portal.md#semantic-search).
126
119
127
-
***Filter APIs** by type or lifecycle stage
120
+
***Filter APIs** by type or lifecycle stage.
128
121
129
-
***View API details and definitions** including endpoints, methods, parameters, and response formats
122
+
***View API details and definitions** including endpoints, methods, parameters, and response formats.
130
123
131
-
***Download API definitions** to a local computer or open them in Visual Studio Code
124
+
***Download API definitions** to a local computer or open them in Visual Studio Code.
132
125
133
-
***Try out APIs** that support API key authentication or OAuth 2.0 authorization
126
+
***Try out APIs** that support API key authentication or OAuth 2.0 authorization.
0 commit comments