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
> We recommend that you use [Microsoft Entra External ID](/entra/external-id/external-identities-overview) as an identity provider instead of Azure Active Directory B2C for new deployments of the API Management developer portal. For more information, see [How to authorize developer accounts by using Microsoft Entra External ID](api-management-howto-entra-external-id.md).
24
+
> We recommend that you [enable access by external users in your Microsoft Entra ID workforce tenant](api-management-howto-aad.md#enable-access-by-external-users-in-your-microsoft-entra-id-tenant-optional)instead of configuring Azure Active Directory B2C for new deployments of the API Management developer portal.
25
25
26
26
Azure Active Directory B2C is a cloud identity management solution for consumer-facing web and mobile applications. You can use it to manage access to your API Management developer portal.
Copy file name to clipboardExpand all lines: articles/api-management/api-management-howto-aad.md
+51-22Lines changed: 51 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ description: Learn how to enable user sign-in to the API Management developer po
6
6
author: dlepow
7
7
ms.service: azure-api-management
8
8
ms.topic: how-to
9
-
ms.date: 12/12/2025
9
+
ms.date: 03/12/2026
10
10
ms.author: danlep
11
11
ms.custom:
12
12
- engagement-fy23
@@ -22,16 +22,15 @@ ms.custom:
22
22
In this article, you learn how to:
23
23
> [!div class="checklist"]
24
24
> * Enable access to the developer portal for users in your organization's Microsoft Entra ID tenant or other Microsoft Entra ID workforce tenants.
25
+
> * Optionally, add external identity providers, such as Google or Facebook, to your Microsoft Entra ID workforce tenant to allow users to sign in with those accounts.
25
26
> * Manage groups of Microsoft Entra users by adding external groups that contain the users.
26
27
27
28
For an overview of options to secure the developer portal, see [Secure access to the API Management developer portal](secure-developer-portal-access.md).
28
29
29
30
> [!IMPORTANT]
30
-
> * This article is updated with steps to configure a Microsoft Entra app using the Microsoft Authentication Library ([MSAL](../active-directory/develop/msal-overview.md)).
31
+
> * This article is updated with steps to configure a Microsoft Entra app by using the Microsoft Authentication Library ([MSAL](../active-directory/develop/msal-overview.md)).
31
32
> * If you previously configured a Microsoft Entra app for user sign-in by using the Azure AD Authentication Library (ADAL), [migrate to MSAL](#migrate-to-msal).
32
33
33
-
For scenarios involving Microsoft External ID to allow external identities to sign in to the developer portal, see [Authorize access to API Management developer portal by using Microsoft Entra External ID](api-management-howto-entra-external-id.md).
@@ -66,26 +65,51 @@ For steps, see [Switch redirect URIs to the single-page application type](../act
66
65
1.[Republish your developer portal](developer-portal-overview.md#publish-the-portal).
67
66
68
67
69
-
<aname='add-an-external-azure-ad-group'></a>
68
+
<aname='enable-access-by-external-users'></a>
69
+
70
+
## Enable access by external users in your Microsoft Entra ID tenant (optional)
71
+
72
+
API Management supports external identity providers when you configure them in a Microsoft Entra ID workforce tenant. For example, if you're enabling access to the developer portal by users in your workforce tenant, such as the Contoso organization, you might want to configure Google or Facebook as an external identity provider so that these external users can also sign in by using their accounts.
73
+
74
+
To optionally enable access to the developer portal by external users in your Microsoft Entra ID tenant, complete the following steps:
75
+
76
+
1. Add an external identity provider to your Microsoft Entra ID tenant.
77
+
1. Enable self-service sign-up.
78
+
79
+
### 1. Add an external identity provider to your Microsoft Entra ID tenant
80
+
81
+
For this scenario, you must enable an external identity provider in your workforce tenant. Configuring the external identity provider depends on the specific provider and is outside the scope of this article. For example, for Google you must create a project in the Google Developers Console, then configure the project credentials in Microsoft Entra.
82
+
83
+
For options and links to steps, see [Identity providers for External ID in workforce tenants](/entra/external-id/identity-providers).
70
84
71
-
## Configure access by users in more than one Microsoft Entra tenant
85
+
### 2. Enable self-service sign-up
86
+
87
+
To allow external users to register for access to the developer portal, complete the following steps:
88
+
89
+
a. Enable self-service sign-up for your tenant.
90
+
91
+
b. Add your app to the self-service sign-up user flow.
92
+
93
+
For more information and detailed steps, see [Add self-service sign-up user flows for B2B collaboration](/entra/external-id/self-service-sign-up-user-flow).
94
+
95
+
## Enable access by users in more than one Microsoft Entra ID tenant (optional)
72
96
73
97
> [!NOTE]
74
98
> Support for access to the developer portal by users from multiple Microsoft Entra ID tenants is currently available in the API Management Developer, Standard, and Premium tiers.
75
99
76
-
You can enable access to the developer portal by users from more than one Microsoft Entra ID tenant. To do this:
100
+
To optionally enable access to the developer portal by users from more than one Microsoft Entra ID tenant, complete the following steps:
77
101
78
-
* Configure app registration for multiple tenants.
79
-
* Update the Microsoft Entra ID identity provider configuration for the developer portal to add another tenant.
102
+
1. Configure app registration for multiple tenants.
103
+
1. Update the Microsoft Entra ID identity provider configuration for the developer portal to add another tenant.
80
104
81
-
### Configure app registration for multiple tenants
105
+
### 1. Configure app registration for multiple tenants
82
106
83
-
The app registration you configure for the identity provider must support multiple tenants. You can do this in either of the following ways:
107
+
The app registration must support multiple tenants. You can configure this support in either of the following ways:
84
108
85
109
* When creating the app registration, set **Supported account types** to **Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)**.
86
110
* If you previously configured an app registration for a single tenant, update the **Supported account types** setting on the **Manage** > **Authentication** page of the app registration.
87
111
88
-
### Update Microsoft Entra ID identity provider configuration for multiple tenants
112
+
### 2. Update Microsoft Entra ID identity provider configuration for multiple tenants
89
113
90
114
Update the identity provider configuration to add another tenant:
91
115
@@ -97,6 +121,8 @@ Update the identity provider configuration to add another tenant:
97
121
1. Select **Update**.
98
122
1.[Republish your developer portal](developer-portal-overview.md#publish-the-portal).
99
123
124
+
<aname='add-an-external-azure-ad-group'></a>
125
+
100
126
## Add an external Microsoft Entra group
101
127
102
128
After you enable access for users in a Microsoft Entra tenant, you can:
@@ -119,7 +145,7 @@ Now you can add external Microsoft Entra groups from the **Groups** tab of your
119
145
120
146
1. Select the **Tenant** from the drop-down.
121
147
1. Search for and select the group that you want to add.
122
-
1.Press the **Select** button.
148
+
1.Select **Select**.
123
149
124
150
After you add an external Microsoft Entra group, you can review and configure its properties:
125
151
1. Select the name of the group from the **Groups** tab.
@@ -137,13 +163,13 @@ Users from the configured Microsoft Entra instance can now:
137
163
Groups you configure in Microsoft Entra must synchronize with API Management so that you can add them to your instance. If the groups don't synchronize automatically, use one of the following steps to manually synchronize group information:
138
164
139
165
* Sign out and sign in to Microsoft Entra ID. This activity usually triggers synchronization of groups.
140
-
* Ensure that the Microsoft Entra sign-in tenant is specified the same way (using one of tenant ID or domain name) in your configuration settings in API Management. You specify the sign-in tenant in the Microsoft Entra ID identity provider for the developer portal and when you add a Microsoft Entra group to API Management.
166
+
* Ensure that you specify the Microsoft Entra sign-in tenant the same way (by using either the tenant ID or domain name) in your configuration settings in API Management. You specify the sign-in tenant in the Microsoft Entra ID identity provider for the developer portal and when you add a Microsoft Entra group to API Management.
141
167
142
168
## <aid="log_in_to_dev_portal"></a> Developer portal: Add Microsoft Entra account authentication
143
169
144
170
In the developer portal, you can enable sign in with Microsoft Entra ID by using the **Sign-in button: OAuth** widget included on the sign-in page of the default developer portal content.
145
171
146
-
A user can then sign in with Microsoft Entra ID as follows:
172
+
A user can then sign in by using Microsoft Entra ID as follows:
147
173
148
174
1. Go to the developer portal. Select **Sign in**.
149
175
@@ -153,22 +179,25 @@ A user can then sign in with Microsoft Entra ID as follows:
153
179
:::image type="content" source="media/api-management-howto-aad/developer-portal-azure-ad-signin.png" alt-text="Screenshot showing OAuth widget in developer portal.":::
154
180
155
181
> [!TIP]
156
-
> If more than one tenant is configured for access, more than one Microsoft Entra ID button appears on the sign-in page. Each button is labeled with the tenant name.
182
+
> If you configure more than one tenant for access, more than one Microsoft Entra ID button appears on the sign-in page. Each button is labeled with the tenant name.
183
+
184
+
1. In the sign-in window for the Microsoft Entra tenant, respond to the prompts.
157
185
158
-
1. In the sign-in window for your Microsoft Entra tenant, respond to the prompts. After sign-in is complete, the user is redirected back to the developer portal.
186
+
> [!NOTE]
187
+
> If you enabled an external identity provider in your Microsoft Entra tenant and configured self-service sign-up, select the external identity provider in the sign-in window to sign in with those credentials. For example, if you configured Google as an identity provider, select **Sign in with Google**.
159
188
160
-
The user is now signed in to the developer portal and added as a new API Management user identity in **Users**.
189
+
After sign-in is complete, the user is redirected back to the developer portal. The user is now signed in to the developer portal and added as a new API Management user identity in **Users**.
161
190
162
-
Although a new account is automatically created when a new user signs in with Microsoft Entra ID, consider adding the same widget to the sign-up page. The **Sign-up form: OAuth** widget represents a form used for signing up with OAuth.
191
+
Although a new account is automatically created when a new user signs in by using Microsoft Entra ID, consider adding the same widget to the sign-up page. The **Sign-up form: OAuth** widget represents a form used for signing up by using OAuth.
163
192
164
193
> [!IMPORTANT]
165
194
> You need to [republish the portal](developer-portal-overview.md#publish-the-portal) for the Microsoft Entra ID changes to take effect.
166
195
167
196
## Related content
168
197
169
-
-Learn more about [Microsoft Entra ID and OAuth2.0](../active-directory/develop/authentication-vs-authorization.md).
170
-
-Learn more about [MSAL](../active-directory/develop/msal-overview.md) and [migrating to MSAL](../active-directory/develop/msal-migration.md).
171
-
-[Troubleshoot network connectivity to Microsoft Graph from inside a VNet](api-management-using-with-vnet.md#troubleshoot-connection-to-microsoft-graph-from-inside-a-vnet).
198
+
-To learn more about Microsoft Entra ID and OAuth 2.0, see[Microsoft Entra ID and OAuth2.0](../active-directory/develop/authentication-vs-authorization.md).
199
+
-To learn more about MSAL, see[MSAL](../active-directory/develop/msal-overview.md) and [migrating to MSAL](../active-directory/develop/msal-migration.md).
200
+
-To troubleshoot network connectivity to Microsoft Graph from inside a virtual network, see [Troubleshoot network connectivity to Microsoft Graph from inside a VNet](api-management-using-with-vnet.md#troubleshoot-connection-to-microsoft-graph-from-inside-a-vnet).
0 commit comments