Skip to content

Commit da082ab

Browse files
author
gitName
committed
work in progress
1 parent 2a9d007 commit da082ab

File tree

1 file changed

+29
-17
lines changed

1 file changed

+29
-17
lines changed

articles/api-management/applications.md

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -39,12 +39,14 @@ This feature enables:
3939
> [!NOTE]
4040
> If you don't have access to an EUAP region, you can [request it](/troubleshoot/azure/general/region-access-request-process) through the Azure portal.
4141
42-
- At least one product in your API Management instance, with at least one API assigned to it. If you haven't yet created a product, see [Create and publish a product](api-management-howto-add-products.md). For testing, you may use the default **Starter** product and the **Echo** API that's added to it.
42+
- At least one product in your API Management instance, with at least one API assigned to it. If you haven't yet created a product, see [Create and publish a product](api-management-howto-add-products.md). For testing, you may use the default **Starter** product and the **Echo** API that's added to it. The product should be in the **Published** state so that it can be accessed by developers through the developer portal.
4343

4444
- Permissions to create an app registration in your Microsoft Entra tenant.
4545

4646
- Permissions to assign the **Application Administrator** role, which requires at least the **Privileged Role Administrator** role in Microsoft Entra.
4747

48+
- Optionally, one or more [users](api-management-howto-create-or-invite-developers.md) in your API Management instance.
49+
4850

4951
[Any special considerations to access the preview - regions, special URLs, etc.]
5052

@@ -59,6 +61,8 @@ The following are the high level configuration steps:
5961
1. After successful validation, Microsoft Entra ID issues the access/refresh token.
6062

6163

64+
<!-- Clarify personas for API Management and developer portal. -->
65+
6266

6367

6468
## Configure managed identity
@@ -78,25 +82,26 @@ The following are the high level configuration steps:
7882

7983
## Enable application based access for product
8084

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.
85+
Follow these steps to enable **Application based access** for a product:
8286

83-
> [!TIP]
84-
> You can also enable the **Application based access** setting when creating a new product.
87+
1. Sign in to the [Azure portal](https://portal.azure.com) and navigate to your API Management instance.
88+
2. In the left menu, under **APIs**, select **Products**.
89+
3. Choose the product you want to configure, such as the **Starter** product.
90+
4. In the left menu, under **Product**, select **Properties**.
91+
5. Enable the **Application based access** setting.
92+
6. Click **Save**.
8593

86-
1. Sign in to the Azure portal at the following URL () and navigate to your API Management instance.
87-
1. In the left menu, under **APIs**, select **Products**.
88-
1. Select the product you want to enable OAuth 2.0 authorization for. For this example, select the **Starter** product.
89-
1. In the left menu, under **Product**, select **Properties**.
90-
1. Enable **Application based access**.
91-
1. Select **Save**.
94+
Enabling this setting automatically creates a client application in Microsoft Entra ID for the selected product.
9295

9396
:::image type="content" source="media/applications/enable-application-based-access.png" alt-text="Screenshot of enabling application based access in the portal.":::
9497

95-
96-
After you enable application based access, an enterprise application is created.
98+
> [!TIP]
99+
> You can also enable the **Application based access** setting when creating a new product.
97100
98101
### Review application settings
99102

103+
After you enable application based access, an enterprise application is created.
104+
100105
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.
101106

102107
You can review application settings in **App registrations**.
@@ -110,22 +115,29 @@ You can review application settings in **App registrations**.
110115

111116
## Create application for multiple products
112117

113-
You can also create an application that can access multiple products.
118+
You can also create an application directly in the portal that can access multiple products. Products must have **Application based access** enabled to have the application access them.
114119

115-
1. Sign in to the Azure portal at the following URL () and navigate to your API Management instance.
120+
1. Sign in to the Azure portal at the following URL (`https://portal.azure.com/?showversion=true&feature.customPortal=false&Microsoft_Azure_ApiManagement=javierbo2&applicationNewRoleValueFormat=true`) and navigate to your API Management instance.
116121
1. In the left menu, under **APIs**, select **Applications** > **+ Register application**.
117122
1. In the **Register an application** pane,
118123
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? -->
124+
* **Name**: Enter a name for the application.
125+
* **Owner**: Select the owner of the application from the dropdown list. This list includes all users in the API Management instance.
126+
* **Grant access to selected products**: Select one or more products that you want the application to access. You can select one or more products in the API Management instance that have **Application based access** enabled.
122127
* **Description**: Optionally enter a description.
123128

124129
:::image type="content" source="media/applications/register-application.png" alt-text="Screenshot of application settings in the portal.":::
125130
1. Select **Register**.
126131

132+
133+
<!-- Should the application then appear in the list of applications? -->
134+
135+
136+
127137
## Add/remove products in application
128138

139+
140+
129141
## Create token and use with API call
130142

131143
## List applications and get secrets in the developer portal

0 commit comments

Comments
 (0)