Skip to content

Commit 2a9d007

Browse files
author
gitName
committed
wip
1 parent 3bdb329 commit 2a9d007

File tree

3 files changed

+40
-9
lines changed

3 files changed

+40
-9
lines changed

articles/api-management/applications.md

Lines changed: 40 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Authorize test console of API Management developer portal - OAuth 2.0
2+
title: Create OAuth application access to product - Azure API Management
33
titleSuffix: Azure API Management
4-
description: Set up OAuth 2.0 user authorization for the test console in Azure API Management developer portal. This example uses Microsoft Entra ID as OAuth 2.0 provider.
4+
description: TBD
55
services: api-management
66
author: dlepow
77

88
ms.service: azure-api-management
99
ms.topic: how-to
10-
ms.date: 01/06/2025
10+
ms.date: 05/02/2025
1111
ms.author: danlep
12-
ms.custom: engagement-fy23
12+
ms.custom:
1313
---
1414

1515
# Create and authorize access to products using OAuth 2.0 application
1616

1717
[!INCLUDE [api-management-availability-premium-dev-standard-basic](../../includes/api-management-availability-premium-dev-standard-basic.md)]
1818

19-
19+
[Intro here]
2020

2121

2222
Applications feature is now available for private preview testing.
@@ -27,7 +27,7 @@ Applications feature is now available for private preview testing.
2727
2828
This feature enables:
2929

30-
* API Management gateway can now authorize product/API access using OAuth token
30+
* API Management gateway can now authorize product/API access using OAuth token **in client credentials flow**
3131
* API managers can identify products which have OAuth authorization enabled
3232
* API managers can create client applications and assign access to products
3333
* Developers can view all client applications and use OAuth token to get secure access to product/API
@@ -76,9 +76,12 @@ The following are the high level configuration steps:
7676
1. In the **Add assignments** pane, search for the API Management instance's managed identity by name or object (prinicipal) ID, select it, and then select **Add**.
7777

7878

79-
## Enable OAuth 2.0 authorization for product
79+
## Enable application based access for product
80+
81+
To enable OAuth 2.0 authorization for a product, can enable **Application based access** in the product settings. This setting automatically creates a client application in Microsoft Entra ID for this product.
8082

81-
To enable OAuth 2.0 authorization for a product, you must first enable **Application based access** in the product settings. This setting automatically creates a client application in Microsoft Entra ID for this product.
83+
> [!TIP]
84+
> You can also enable the **Application based access** setting when creating a new product.
8285
8386
1. Sign in to the Azure portal at the following URL () and navigate to your API Management instance.
8487
1. In the left menu, under **APIs**, select **Products**.
@@ -90,8 +93,36 @@ To enable OAuth 2.0 authorization for a product, you must first enable **Applica
9093
:::image type="content" source="media/applications/enable-application-based-access.png" alt-text="Screenshot of enabling application based access in the portal.":::
9194

9295

96+
After you enable application based access, an enterprise application is created.
97+
98+
### Review application settings
99+
100+
The application is named with the following format: **APIMProductApplication<product-name>**. For example, if the product name is **Starter**, the application name is **APIMProductApplicationStarter**. The application should have an **App role** defined.
101+
102+
You can review application settings in **App registrations**.
93103

94-
## Create application in Microsoft Entra ID
104+
1. Sign in to the Azure portal and naviage to **App registrations**.
105+
1. Select **All applications** and search for the application created by API Management.
106+
1. In the left menu, under **Manage**, select **App roles**.
107+
1. Confirm that an application role was set by Azure API Management, as shown in the following screenshot:
108+
109+
:::image type="content" source="media/applications/application-roles.png" alt-text="Screenshot of app roles in the portal.":::
110+
111+
## Create application for multiple products
112+
113+
You can also create an application that can access multiple products.
114+
115+
1. Sign in to the Azure portal at the following URL () and navigate to your API Management instance.
116+
1. In the left menu, under **APIs**, select **Applications** > **+ Register application**.
117+
1. In the **Register an application** pane,
118+
1. Enter the following application settings:
119+
* **Name**: Enter a name for the application. For example, **MyApp**.
120+
* **Owner**: Select the owner of the application from the dropdown list. <!-- What are options here? -->
121+
* **Grant access to selected products**: Select one or more products that you want the application to access. <!--Why were some product options greyed out? -->
122+
* **Description**: Optionally enter a description.
123+
124+
:::image type="content" source="media/applications/register-application.png" alt-text="Screenshot of application settings in the portal.":::
125+
1. Select **Register**.
95126

96127
## Add/remove products in application
97128

59.3 KB
Loading
65.5 KB
Loading

0 commit comments

Comments
 (0)