Skip to content

Commit 2d29d1d

Browse files
committed
Merge branch 'main' into release-aio-2603
2 parents 04f721a + 5ea7846 commit 2d29d1d

31 files changed

Lines changed: 814 additions & 628 deletions

articles/api-management/TOC.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -465,8 +465,6 @@
465465
href: developer-portal-basic-authentication.md
466466
- name: Authenticate with Microsoft Entra ID
467467
href: api-management-howto-aad.md
468-
- name: Authenticate with Microsoft Entra External ID
469-
href: api-management-howto-entra-external-id.md
470468
- name: Authenticate with Azure AD B2C
471469
href: api-management-howto-aad-b2c.md
472470
- name: Delegate authentication

articles/api-management/api-management-howto-aad-b2c.md

Lines changed: 2 additions & 2 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: 09/18/2025
10+
ms.date: 03/12/2026
1111
ms.author: danlep
1212
ms.custom:
1313
- engagement-fy23
@@ -21,7 +21,7 @@ ms.custom:
2121
[!INCLUDE [active-directory-b2c-end-of-sale-notice-b](../../includes/active-directory-b2c-end-of-sale-notice-b.md)]
2222

2323
> [!IMPORTANT]
24-
> 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.
2525
2626
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.
2727

articles/api-management/api-management-howto-aad.md

Lines changed: 51 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ description: Learn how to enable user sign-in to the API Management developer po
66
author: dlepow
77
ms.service: azure-api-management
88
ms.topic: how-to
9-
ms.date: 12/12/2025
9+
ms.date: 03/12/2026
1010
ms.author: danlep
1111
ms.custom:
1212
- engagement-fy23
@@ -22,16 +22,15 @@ ms.custom:
2222
In this article, you learn how to:
2323
> [!div class="checklist"]
2424
> * 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.
2526
> * Manage groups of Microsoft Entra users by adding external groups that contain the users.
2627
2728
For an overview of options to secure the developer portal, see [Secure access to the API Management developer portal](secure-developer-portal-access.md).
2829

2930
> [!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)).
3132
> * 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).
3233
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).
34-
3534
[!INCLUDE [api-management-developer-portal-entra-tenants.md](../../includes/api-management-developer-portal-entra-tenants.md)]
3635

3736

@@ -66,26 +65,51 @@ For steps, see [Switch redirect URIs to the single-page application type](../act
6665
1. [Republish your developer portal](developer-portal-overview.md#publish-the-portal).
6766

6867

69-
<a name='add-an-external-azure-ad-group'></a>
68+
<a name='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).
7084

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)
7296

7397
> [!NOTE]
7498
> 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.
7599
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:
77101

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.
80104

81-
### Configure app registration for multiple tenants
105+
### 1. Configure app registration for multiple tenants
82106

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:
84108

85109
* When creating the app registration, set **Supported account types** to **Accounts in any organizational directory (Any Microsoft Entra ID tenant - Multitenant)**.
86110
* 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.
87111

88-
### Update Microsoft Entra ID identity provider configuration for multiple tenants
112+
### 2. Update Microsoft Entra ID identity provider configuration for multiple tenants
89113

90114
Update the identity provider configuration to add another tenant:
91115

@@ -97,6 +121,8 @@ Update the identity provider configuration to add another tenant:
97121
1. Select **Update**.
98122
1. [Republish your developer portal](developer-portal-overview.md#publish-the-portal).
99123

124+
<a name='add-an-external-azure-ad-group'></a>
125+
100126
## Add an external Microsoft Entra group
101127

102128
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
119145

120146
1. Select the **Tenant** from the drop-down.
121147
1. Search for and select the group that you want to add.
122-
1. Press the **Select** button.
148+
1. Select **Select**.
123149

124150
After you add an external Microsoft Entra group, you can review and configure its properties:
125151
1. Select the name of the group from the **Groups** tab.
@@ -137,13 +163,13 @@ Users from the configured Microsoft Entra instance can now:
137163
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:
138164

139165
* 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.
141167

142168
## <a id="log_in_to_dev_portal"></a> Developer portal: Add Microsoft Entra account authentication
143169

144170
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.
145171

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:
147173

148174
1. Go to the developer portal. Select **Sign in**.
149175

@@ -153,22 +179,25 @@ A user can then sign in with Microsoft Entra ID as follows:
153179
:::image type="content" source="media/api-management-howto-aad/developer-portal-azure-ad-signin.png" alt-text="Screenshot showing OAuth widget in developer portal.":::
154180

155181
> [!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.
157185

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**.
159188
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**.
161190

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.
163192

164193
> [!IMPORTANT]
165194
> You need to [republish the portal](developer-portal-overview.md#publish-the-portal) for the Microsoft Entra ID changes to take effect.
166195
167196
## Related content
168197

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).
172201

173202
[api-management-dev-portal-signin]: ./media/api-management-howto-aad/api-management-dev-portal-signin.png
174203
[api-management-aad-signin]: ./media/api-management-howto-aad/api-management-aad-signin.png

articles/api-management/api-management-howto-entra-external-id.md

Lines changed: 0 additions & 83 deletions
This file was deleted.

0 commit comments

Comments
 (0)