Skip to content

Commit 4a46078

Browse files
scottaddiescottaddie
authored
Document the AAD & AAD B2C authentication APIs breaking change (#20576)
1 parent a7dfe75 commit 4a46078

File tree

3 files changed

+63
-0
lines changed

3 files changed

+63
-0
lines changed

‎docs/core/compatibility/3.1-5.0.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ If you're migrating from version 3.1 of .NET Core, ASP.NET Core, or EF Core to v
99

1010
## ASP.NET Core
1111

12+
- [Authentication: AzureAD.UI and AzureADB2C.UI APIs and packages marked obsolete](#authentication-azureadui-and-azureadb2cui-apis-and-packages-marked-obsolete)
1213
- [Authorization: Resource in endpoint routing is HttpContext](#authorization-resource-in-endpoint-routing-is-httpcontext)
1314
- [Azure: Microsoft-prefixed Azure integration packages removed](#azure-microsoft-prefixed-azure-integration-packages-removed)
1415
- [Blazor: Insignificant whitespace trimmed from components at compile time](#blazor-insignificant-whitespace-trimmed-from-components-at-compile-time)
@@ -35,6 +36,10 @@ If you're migrating from version 3.1 of .NET Core, ASP.NET Core, or EF Core to v
3536
- [SignalR: UseSignalR and UseConnections methods removed](#signalr-usesignalr-and-useconnections-methods-removed)
3637
- [Static files: CSV content type changed to standards-compliant](#static-files-csv-content-type-changed-to-standards-compliant)
3738

39+
[!INCLUDE[Authentication: AzureAD.UI and AzureADB2C.UI APIs and packages marked obsolete](~/includes/core-changes/aspnetcore/5.0/authentication-aad-packages-obsolete.md)]
40+
41+
***
42+
3843
[!INCLUDE[Authorization: Resource in endpoint routing is HttpContext](~/includes/core-changes/aspnetcore/5.0/authorization-resource-in-endpoint-routing.md)]
3944

4045
***

‎docs/core/compatibility/aspnetcore.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Select one of the following links for breaking changes in a specific version:
1919
The following breaking changes in ASP.NET Core 3.0, 3.1, and 5.0 are documented on this page:
2020

2121
- [Obsolete Antiforgery, CORS, Diagnostics, MVC, and Routing APIs removed](#obsolete-antiforgery-cors-diagnostics-mvc-and-routing-apis-removed)
22+
- [Authentication: AzureAD.UI and AzureADB2C.UI APIs and packages marked obsolete](#authentication-azureadui-and-azureadb2cui-apis-and-packages-marked-obsolete)
2223
- [Authentication: Google+ deprecation](#authentication-google-deprecated-and-replaced)
2324
- [Authentication: HttpContext.Authentication property removed](#authentication-httpcontextauthentication-property-removed)
2425
- [Authentication: Newtonsoft.Json types replaced](#authentication-newtonsoftjson-types-replaced)
@@ -99,6 +100,10 @@ The following breaking changes in ASP.NET Core 3.0, 3.1, and 5.0 are documented
99100

100101
## ASP.NET Core 5.0
101102

103+
[!INCLUDE[Authentication: AzureAD.UI and AzureADB2C.UI APIs and packages marked obsolete](~/includes/core-changes/aspnetcore/5.0/authentication-aad-packages-obsolete.md)]
104+
105+
***
106+
102107
[!INCLUDE[Authorization: Resource in endpoint routing is HttpContext](~/includes/core-changes/aspnetcore/5.0/authorization-resource-in-endpoint-routing.md)]
103108

104109
***

‎includes/core-changes/aspnetcore/5.0/authentication-aad-packages-obsolete.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
### Authentication: AzureAD.UI and AzureADB2C.UI APIs and packages marked obsolete
2+
3+
In ASP.NET Core 2.1, integration with Azure Active Directory (Azure AD) and Azure Active Directory B2C (Azure AD B2C) authentication is provided by the [Microsoft.AspNetCore.Authentication.AzureAD.UI](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.AzureAD.UI) and [Microsoft.AspNetCore.Authentication.AzureADB2C.UI](https://www.nuget.org/packages/Microsoft.AspNetCore.Authentication.AzureADB2C.UI) packages. The functionality provided by these packages is based on the Azure AD v1.0 endpoint.
4+
5+
In ASP.NET Core 5.0 and later, integration with Azure AD and Azure AD B2C authentication is provided by the [Microsoft.Identity.Web](https://www.nuget.org/packages/Microsoft.Identity.Web) package. This package is based on the Microsoft Identity Platform, which is formerly known as the Azure AD v2.0 endpoint. Consequently, the old APIs in the `Microsoft.AspNetCore.Authentication.AzureAD.UI` and `Microsoft.AspNetCore.Authentication.AzureADB2C.UI` packages were deprecated.
6+
7+
For discussion, see GitHub issue [dotnet/aspnetcore#25807](https://github.com/dotnet/aspnetcore/issues/25807).
8+
9+
#### Version introduced
10+
11+
5.0 Preview 8
12+
13+
#### Old behavior
14+
15+
The APIs weren't marked as obsolete.
16+
17+
#### New behavior
18+
19+
The APIs are marked as obsolete.
20+
21+
#### Reason for change
22+
23+
The Azure AD and Azure AD B2C authentication functionality was migrated to Microsoft Authentication Library (MSAL) APIs that are provided by `Microsoft.Identity.Web`.
24+
25+
#### Recommended action
26+
27+
Follow the `Microsoft.Identity.Web` API guidance for [web apps](https://github.com/azuread/microsoft-identity-web/wiki/web-apps) and [web APIs](https://github.com/azuread/microsoft-identity-web/wiki/web-apis).
28+
29+
#### Category
30+
31+
ASP.NET Core
32+
33+
#### Affected APIs
34+
35+
* [Microsoft.AspNetCore.Authentication.AzureADAuthenticationBuilderExtensions](/dotnet/api/microsoft.aspnetcore.authentication.azureadauthenticationbuilderextensions?view=aspnetcore-3.0)
36+
* [Microsoft.AspNetCore.Authentication.AzureAD.UI.AzureADDefaults](/dotnet/api/microsoft.aspnetcore.authentication.azuread.ui.azureaddefaults?view=aspnetcore-3.0)
37+
* [Microsoft.AspNetCore.Authentication.AzureAD.UI.AzureADOptions](/dotnet/api/microsoft.aspnetcore.authentication.azuread.ui.azureadoptions?view=aspnetcore-3.0)
38+
* [Microsoft.AspNetCore.Authentication.AzureADB2CAuthenticationBuilderExtensions](/dotnet/api/microsoft.aspnetcore.authentication.azureadb2cauthenticationbuilderextensions?view=aspnetcore-3.0)
39+
* [Microsoft.AspNetCore.Authentication.AzureADB2C.UI.AzureADB2CDefaults](/dotnet/api/microsoft.aspnetcore.authentication.azureadb2c.ui.azureadb2cdefaults?view=aspnetcore-3.0)
40+
* [Microsoft.AspNetCore.Authentication.AzureADB2C.UI.AzureADB2COptions](/dotnet/api/microsoft.aspnetcore.authentication.azureadb2c.ui.azureadb2coptions?view=aspnetcore-3.0)
41+
42+
<!--
43+
44+
#### Affected APIs
45+
46+
- `T:Microsoft.AspNetCore.Authentication.AzureADAuthenticationBuilderExtensions`
47+
- `T:Microsoft.AspNetCore.Authentication.AzureAD.UI.AzureADDefaults`
48+
- `T:Microsoft.AspNetCore.Authentication.AzureAD.UI.AzureADOptions`
49+
- `T:Microsoft.AspNetCore.Authentication.AzureADB2CAuthenticationBuilderExtensions`
50+
- `T:Microsoft.AspNetCore.Authentication.AzureADB2C.UI.AzureADB2CDefaults`
51+
- `T:Microsoft.AspNetCore.Authentication.AzureADB2C.UI.AzureADB2COptions`
52+
53+
-->

0 commit comments

Comments
 (0)