Sparc.Authentication.AzureADB2C 7.0.0

dotnet add package Sparc.Authentication.AzureADB2C --version 7.0.0
NuGet\Install-Package Sparc.Authentication.AzureADB2C -Version 7.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Sparc.Authentication.AzureADB2C" Version="7.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Sparc.Authentication.AzureADB2C --version 7.0.0
#r "nuget: Sparc.Authentication.AzureADB2C, 7.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Sparc.Authentication.AzureADB2C as a Cake Addin
#addin nuget:?package=Sparc.Authentication.AzureADB2C&version=7.0.0

// Install Sparc.Authentication.AzureADB2C as a Cake Tool
#tool nuget:?package=Sparc.Authentication.AzureADB2C&version=7.0.0

Sparc.Authentication.AzureADB2C

Nuget

The Sparc.Authentication.AzureADB2C plugin is a plug-and-play authentication plugin that hooks up all API authentication in your Features Project to Azure AD B2C.

Add this plugin to your Features Project if you'd like to use Azure AD B2C as your app's authentication provider.

Get Started with Sparc.Authentication.AzureADB2C

Set up Azure Active Directory B2C

Follow the guide here to set up two applications within Azure AD B2C -- one for your Features Project, and one for your UI Project.

Take note of the following items as you are setting things up. You will need these later on in the process:

  • The name of your B2C domain
  • The Client ID (Guid) of your Azure AD B2C Features (Server) Application
  • The Client ID (Guid) of your Azure AD B2C UI (Client) Application
  • The Sign Up/Sign In and Reset Password Policy IDs
  • The URI of the scope you create to connect the Features (Server) & UI (Client) applications

In Your Features Project:

  1. Add the Sparc.Authentication.AzureADB2C Nuget package: Nuget

  2. Add the following settings to your appsettings.json file, replacing the values as necessary to match your application:

     {
      "AzureAdB2C": {
        "Instance": "https://mydomainname.b2clogin.com/tfp/",
        "ClientId": "00000000-0000-0000-0000-000000000000", // the Client ID of your Azure AD B2C Features/API Project
        "Domain": "mydomainname.onmicrosoft.com",
        "SignUpSignInPolicyId": "B2C_1_SignIn_SignUp",
        "ResetPasswordPolicyId": "B2C_1_ForgotPassword"
       }
     }
    
  3. Add the following line of code to your Startup.cs file to register the Sparc.Authentication.AzureADB2C plugin. It will automatically read the data from the AzureAdB2C configuration in your appsettings.json.

    services.AddAzureADB2CAuthentication(Configuration);
    

In your Platform projects (Web/Maui):

  1. Add the following settings to your wwwroot/appsettings.json file, replacing the values as necessary to match your application:

    {
      "AzureAdB2C": {
        "Authority": "https://mydomainname.b2clogin.com/tfp/mydomainname.onmicrosoft.com/B2C_1_SignIn_SignUp",
        "ClientId": "00000000-0000-0000-0000-000000000000", // the Client ID of your Azure AD B2C UI Project
        "ValidateAuthority": false
      }
    }
    
  2. Add the following line of code to your Startup.cs or MauiProgram.cs file to register the client features in Authentication. Pass in:

    • your auto-generated Api class type (generated from your OpenApiReference -- more info in the Sparc.UI documentation)
    • the scope URI from your AD B2C Setup in Azure (this gives your UI Project access to the Features Project)
    • the base URL of your Features Project (this sets up the base URL for your auto-generated Api class and configures it for proper authentication headers)
        builder.AddB2CApi<MyAppApi>(
            "https://myapp.onmicrosoft.com/00000000-0000-0000-0000-000000000000/MyApp.Access",
            builder.Configuration["ApiUrl"]);
    

    or

        builder.Services.AddB2CApi<MyAppApi>(
            "https://myapp.onmicrosoft.com/00000000-0000-0000-0000-000000000000/MyApp.Access",
            builder.Configuration["ApiUrl"]);
    

    Note: This registration method exists within the Sparc.Platforms.* projects. There is no need to add this plugin directly to your Platform Projects.

  3. (Web projects only) Add the following line of code to your index.html file. This adds the necessary JS library for Blazor Web Assembly Authentication using MSAL:

    <script src="_content/Microsoft.Authentication.WebAssembly.Msal/AuthenticationService.js"></script>
    
  4. Run your solution. All of your Features will be automatically protected with JWT-based access tokens, and these access tokens will be sent automatically when the users are logged in.

  5. To log in, set your login button to navigate to /authentication/login?returnUrl=. To log out, navigate to /authentication/logout.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
7.0.0 352 11/7/2022
6.0.0 348 11/19/2021
2.7.0 332 11/9/2021
2.0.3 443 4/13/2021
2.0.2 349 4/9/2021