Franz.Common.Messaging.Identity 1.2.63

There is a newer version of this package available.
See the version list below for details.
dotnet add package Franz.Common.Messaging.Identity --version 1.2.63                
NuGet\Install-Package Franz.Common.Messaging.Identity -Version 1.2.63                
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="Franz.Common.Messaging.Identity" Version="1.2.63" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Franz.Common.Messaging.Identity --version 1.2.63                
#r "nuget: Franz.Common.Messaging.Identity, 1.2.63"                
#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 Franz.Common.Messaging.Identity as a Cake Addin
#addin nuget:?package=Franz.Common.Messaging.Identity&version=1.2.63

// Install Franz.Common.Messaging.Identity as a Cake Tool
#tool nuget:?package=Franz.Common.Messaging.Identity&version=1.2.63                

Franz.Common.Messaging.Identity

A library within the Franz Framework designed to integrate identity management with messaging workflows. This package provides tools for handling authorization contexts, building identity-based message structures, and ensuring seamless communication between identity and messaging services.


Features

  • Identity Context Integration:
    • IdentityContextAccessor for managing identity-specific data within messaging workflows.
  • Authorization Message Builder:
    • AuthorizationMessageBuilder for constructing messages with embedded authorization data.
  • Service Registration:
    • ServiceCollectionExtensions for simplifying the setup of identity-aware messaging services.

Version Information

  • Current Version: 1.2.62
  • Part of the private Franz Framework ecosystem.

Dependencies

This package relies on:

  • Franz.Common.Headers: For managing and propagating headers in messaging workflows.
  • Franz.Common.Identity: Core utilities for identity and authorization management.
  • Franz.Common.Messaging: Provides foundational messaging utilities and abstractions.

Installation

From Private Azure Feed

Since this package is hosted privately, configure your NuGet client:

dotnet nuget add source "https://your-private-feed-url" \
  --name "AzurePrivateFeed" \
  --username "YourAzureUsername" \
  --password "YourAzurePassword" \
  --store-password-in-clear-text

Install the package:

dotnet add package Franz.Common.Messaging.Identity --Version 1.2.63

Usage

1. Access Identity Context in Messaging

Use IdentityContextAccessor to retrieve identity-related data in messaging workflows:

using Franz.Common.Messaging.Identity;

public class MyService
{
    private readonly IdentityContextAccessor _identityContextAccessor;

    public MyService(IdentityContextAccessor identityContextAccessor)
    {
        _identityContextAccessor = identityContextAccessor;
    }

    public string GetUserId()
    {
        return _identityContextAccessor.User?.FindFirst("sub")?.Value;
    }
}

2. Build Authorization Messages

Leverage AuthorizationMessageBuilder to create messages with embedded authorization data:

using Franz.Common.Messaging.Identity;

var builder = new AuthorizationMessageBuilder();
var message = builder.WithUserId("12345")
                     .WithRoles(new[] { "Admin", "User" })
                     .Build();

3. Register Identity-Aware Messaging Services

Use ServiceCollectionExtensions to register identity-aware messaging components:

using Franz.Common.Messaging.Identity.Extensions;

public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMessagingWithIdentity();
    }
}

Integration with Franz Framework

The Franz.Common.Messaging.Identity package integrates seamlessly with:

  • Franz.Common.Messaging: Provides messaging abstractions and utilities.
  • Franz.Common.Identity: Extends identity and authorization support into messaging workflows.
  • Franz.Common.Headers: Facilitates header management for identity-based messages.

Contributing

This package is part of a private framework. Contributions are limited to the internal development team. If you have access, follow these steps:

  1. Clone the repository.
  2. Create a feature branch.
  3. Submit a pull request for review.

License

This library is licensed under the MIT License. See the LICENSE file for more details.


Changelog

Version 1.2.63

  • Introduced IdentityContextAccessor for managing identity contexts in messaging workflows.
  • Added AuthorizationMessageBuilder for constructing identity-aware messages.
  • Integrated ServiceCollectionExtensions for simplified registration of identity-aware messaging services.
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on Franz.Common.Messaging.Identity:

Package Downloads
Franz.Common.Http.Messaging

Shared utility library for the Franz Framework.

Franz.Common.Messaging.Bootstrap

Shared utility library for the Franz Framework.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.64 4 1/29/2025
1.2.63 70 1/27/2025
1.2.62 71 1/8/2025