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
+29-17Lines changed: 29 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -39,12 +39,14 @@ This feature enables:
39
39
> [!NOTE]
40
40
> 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.
41
41
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.
43
43
44
44
- Permissions to create an app registration in your Microsoft Entra tenant.
45
45
46
46
- Permissions to assign the **Application Administrator** role, which requires at least the **Privileged Role Administrator** role in Microsoft Entra.
47
47
48
+
- Optionally, one or more [users](api-management-howto-create-or-invite-developers.md) in your API Management instance.
49
+
48
50
49
51
[Any special considerations to access the preview - regions, special URLs, etc.]
50
52
@@ -59,6 +61,8 @@ The following are the high level configuration steps:
59
61
1. After successful validation, Microsoft Entra ID issues the access/refresh token.
60
62
61
63
64
+
<!-- Clarify personas for API Management and developer portal. -->
65
+
62
66
63
67
64
68
## Configure managed identity
@@ -78,25 +82,26 @@ The following are the high level configuration steps:
78
82
79
83
## Enable application based access for product
80
84
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:
82
86
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**.
85
93
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.
92
95
93
96
:::image type="content" source="media/applications/enable-application-based-access.png" alt-text="Screenshot of enabling application based access in the portal.":::
94
97
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.
97
100
98
101
### Review application settings
99
102
103
+
After you enable application based access, an enterprise application is created.
104
+
100
105
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
106
102
107
You can review application settings in **App registrations**.
@@ -110,22 +115,29 @@ You can review application settings in **App registrations**.
110
115
111
116
## Create application for multiple products
112
117
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.
114
119
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.
116
121
1. In the left menu, under **APIs**, select **Applications** > **+ Register application**.
117
122
1. In the **Register an application** pane,
118
123
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.
122
127
***Description**: Optionally enter a description.
123
128
124
129
:::image type="content" source="media/applications/register-application.png" alt-text="Screenshot of application settings in the portal.":::
125
130
1. Select **Register**.
126
131
132
+
133
+
<!-- Should the application then appear in the list of applications? -->
134
+
135
+
136
+
127
137
## Add/remove products in application
128
138
139
+
140
+
129
141
## Create token and use with API call
130
142
131
143
## List applications and get secrets in the developer portal
0 commit comments