Skip to content

Commit 89c3fee

Browse files
Merge pull request #300985 from dlepow/appp
[APIM] Applications - developer portal
2 parents c1bc80c + fe625c8 commit 89c3fee

File tree

3 files changed

+29
-5
lines changed

3 files changed

+29
-5
lines changed

articles/api-management/applications.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ author: dlepow
77

88
ms.service: azure-api-management
99
ms.topic: how-to
10-
ms.date: 05/19/2025
10+
ms.date: 07/11/2025
1111
ms.author: danlep
1212
ms.custom:
1313
- build-2025
@@ -22,9 +22,9 @@ API Management now supports built-in OAuth 2.0 application-based access to produ
2222
> Applications are currently in limited preview. To sign up, fill [this form](https://aka.ms/apimappspreview).
2323
2424
With this feature:
25-
2625
* API managers set a product property to enable application-based access.
2726
* API managers register client applications in Microsoft Entra ID to limit access to specific products.
27+
* Developers can access client application credentials using the API Management developer portal.
2828
* Using the OAuth 2.0 client credentials flow, developers or apps obtain tokens that they can include in API requests
2929
* Tokens presented in API requests are validated by the API Management gateway to authorize access to the product's APIs.
3030

@@ -61,7 +61,8 @@ Follow these steps to enable **Application based access** for a product. A produ
6161

6262
The following example uses the **Starter** product, but choose any published product that has at least one API assigned to it.
6363

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://portal.azure.com/?feature.customPortal=false&Microsoft_Azure_ApiManagement=applications)
65+
1. Navigate to your API Management instance.
6566
1. In the left menu, under **APIs**, select **Products**.
6667
1. Choose the product that you want to configure, such as the **Starter** product.
6768
1. In the left menu, under **Product**, select **Properties**.
@@ -103,10 +104,13 @@ To review application settings in **App registrations**:
103104
Now register a client application that limits access to one or more products.
104105

105106
* A product must have **Application based access** enabled to be associated with a client application.
106-
* Each client application has a single user (owner) in the API Management instance. One the owner can access product APIs through the application.
107+
* Each client application has a single user (owner) in the API Management instance. Only the owner can access product APIs through the application.
107108
* A product can be associated with more than one client application.
108109

109-
1. Sign in to the [portal](https://portal.azure.com) and navigate to your API Management instance.
110+
To register a client application:
111+
112+
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)
113+
1. Navigate to your API Management instance.
110114
1. In the left menu, under **APIs**, select **Applications** > **+ Register application**.
111115
1. In the **Register an application** page, enter the following application settings:
112116
* **Name**: Enter a name for the application.
@@ -152,6 +156,16 @@ To review application settings in **App registrations**:
152156

153157
:::image type="content" source="media/applications/client-api-permissions.png" alt-text="Screenshot of API permissions in the portal.":::
154158

159+
## Get application settings in developer portal
160+
161+
Users can sign in to the developer portal to view the client applications that they own.
162+
163+
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.
164+
1. In the top navigation menu, select **Applications**.
165+
1. Applications that the user owns appear in the list.
166+
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.
167+
168+
:::image type="content" source="media/applications/applications-developer-portal.png" alt-text="Screenshot of client applications in the developer portal.":::
155169

156170
## Create token and use with API call
157171

@@ -204,6 +218,16 @@ Write-Host "Response:"
204218
$getresponse | ConvertTo-Json -Depth 5
205219
```
206220

221+
## Troubleshooting
222+
223+
### Internal server error when registering applications in the portal
224+
225+
If you're unable to list applications, or you receive an internal server error when registering applications in the portal, check the following:
226+
227+
* The **Application Administrator** role is assigned to the API Management instance's managed identity in Microsoft Entra ID.
228+
* You're signed 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). This URL is required to access the applications feature in API Management.
229+
230+
207231
## Related content
208232

209233
* [Create and publish a product](api-management-howto-add-products.md)
25.5 KB
Loading
10 Bytes
Loading

0 commit comments

Comments
 (0)