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-management/applications.md
+23-6Lines changed: 23 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ author: dlepow
7
7
8
8
ms.service: azure-api-management
9
9
ms.topic: how-to
10
-
ms.date: 06/06/2025
10
+
ms.date: 07/09/2025
11
11
ms.author: danlep
12
12
ms.custom:
13
13
- build-2025
@@ -19,7 +19,7 @@ ms.custom:
19
19
API Management now supports built-in OAuth 2.0 application-based access to product APIs using the client credentials flow. This feature allows API managers to register Microsoft Entra ID applications, streamlining secure API access for developers through OAuth 2.0 authorization.
20
20
21
21
> [!NOTE]
22
-
> Applications are currently in preview.
22
+
> Applications are currently in limited preview. To sign up, fill [this form](https://aka.ms/apimappspreview).
23
23
24
24
With this feature:
25
25
* API managers set a product property to enable application-based access.
@@ -61,7 +61,8 @@ Follow these steps to enable **Application based access** for a product. A produ
61
61
62
62
The following example uses the **Starter** product, but choose any published product that has at least one API assigned to it.
63
63
64
-
1. Sign in to the [portal](https://portal.azure.com) and navigate to your API Management instance.
64
+
1. Sign in to the portal at the following custom URL for the applications feature: [https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications](https://preview.portal.https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications.com)
65
+
1. Navigate to your API Management instance.
65
66
1. In the left menu, under **APIs**, select **Products**.
66
67
1. Choose the product that you want to configure, such as the **Starter** product.
67
68
1. In the left menu, under **Product**, select **Properties**.
@@ -106,7 +107,8 @@ Now register a client application that limits access to one or more products.
106
107
* Each client application has a single user (owner) in the API Management instance. One the owner can access product APIs through the application.
107
108
* A product can be associated with more than one client application.
108
109
109
-
1. Sign in to the [portal](https://portal.azure.com) and navigate to your API Management instance.
110
+
1. Sign in to the portal at the following custom URL for the applications feature: [https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications](https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications.com)
111
+
1. Navigate to your API Management instance.
110
112
1. In the left menu, under **APIs**, select **Applications** > **+ Register application**.
111
113
1. In the **Register an application** page, enter the following application settings:
112
114
***Name**: Enter a name for the application.
@@ -156,9 +158,9 @@ To review application settings in **App registrations**:
156
158
157
159
Users can sign in to the developer portal to view the client applications that they own.
158
160
159
-
1. Sign in to the [developer portal](https://<your-apim-instance-name>.developer.azure-api.net) using a user account that was set as the owner of a client application.
161
+
1. Sign in to the developer portal (`https://<your-apim-instance-name>.developer.azure-api.net`) using a user account that was set as the owner of a client application.
160
162
1. In the top navigation menu, select **Applications**.
161
-
1. Applications that the user owns are listed.
163
+
1. Applications that the user owns appear in the list.
162
164
1. Select an application to view its details, such as the **Client ID**, **Client secret**, and **Scope**. These values are needed to generate a token to call the product APIs.
163
165
164
166
:::image type="content" source="media/applications/applications-developer-portal.png" alt-text="Screenshot of client applications in the developer portal.":::
@@ -214,6 +216,21 @@ Write-Host "Response:"
214
216
$getresponse | ConvertTo-Json -Depth 5
215
217
```
216
218
219
+
## Troubleshooting
220
+
221
+
### Can't enable application-based access for product
222
+
223
+
This is likely a permissions issue. Currently, the API Management administrator must have the **Application Administrator** role assigned in Microsoft Entra ID to enable application-based access for a product.
224
+
225
+
### Internal server error when registering applications in the portal
226
+
227
+
If you receive an internal server error when registering applications in the portal, check the following:
228
+
229
+
* The **Application Administrator** role is assigned to the API Management instance's managed identity in Microsoft Entra ID.
230
+
* You're signed in to the portal at the custom URL for the applications feature: [https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications](https://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications.com). This URL is required to access the applications feature in API Management.
231
+
232
+
233
+
217
234
## Related content
218
235
219
236
*[Create and publish a product](api-management-howto-add-products.md)
0 commit comments