Serilog.Enrichers.AzureClaims 1.1.1

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher. 
dotnet add package Serilog.Enrichers.AzureClaims --version 1.1.1                

                    
                

            
NuGet\Install-Package Serilog.Enrichers.AzureClaims -Version 1.1.1
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="Serilog.Enrichers.AzureClaims" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add Serilog.Enrichers.AzureClaims --version 1.1.1                

                    
                

            
#r "nuget: Serilog.Enrichers.AzureClaims, 1.1.1"
#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 Serilog.Enrichers.AzureClaims as a Cake Addin
#addin nuget:?package=Serilog.Enrichers.AzureClaims&version=1.1.1

// Install Serilog.Enrichers.AzureClaims as a Cake Tool
#tool nuget:?package=Serilog.Enrichers.AzureClaims&version=1.1.1

Serilog.Enrichers.AzureClaims and Serilog.Enrichers.Claims

Enriches Serilog events with information from the ClaimsPrincipal.

Build_and_Test Publish codecov

Nuget Nuget

Nuget Nuget

Install the Serilog.Enrichers.AzureClaims NuGet package
Install the Serilog.Enrichers.Claims NuGet package

Install-Package Serilog.Enrichers.AzureClaims
Install-Package Serilog.Enrichers.Claims

Then, apply the enricher to your LoggerConfiguration:

Log.Logger = new LoggerConfiguration()
    .Enrich.WithUpn()
    .Enrich.WithDisplayName()
    .Enrich.WithTenantId()
    .Enrich.WithObjectId()
    .Enrich.WithAppId()
    .Enrich.WithCustomClaim("AnyExistingClaim") // Available from Serilog.Enrichers.Claims
    // ...other configuration...
    .CreateLogger();

Included enrichers

Available from Serilog.Enrichers.AzureClaims
  • WithUpn() - adds UserPrincipalName based on the ClaimType http://schemas.xmlsoap.org/ws/2005/05/identity/claims/upn
  • WithDisplayName() - adds DisplayName based on the ClaimType http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name or name or preferred_username
  • WithTenantId() - adds TenantId based on the ClaimType http://schemas.microsoft.com/identity/claims/tenantid or tid
  • WithObjectId() - adds ObjectId based on the ClaimType http://schemas.microsoft.com/identity/claims/objectidentifier or oid
  • WithAppId() - adds AppId based on the CLaimType appid or azp
Available from Serilog.Enrichers.Claims
  • WithCustomClaim("AnyExistingClaim") based on the claim you want to extract from the ClaimsPrincipal

Installing into an ASP.NET Core Web Application

The IHttpContextAccessor singleton should be registered, but is not required for these nugets to run. The enrichers have access to the requests HttpContext to extract the data. This is what your Program class should contain in order for this enricher to work as expected:

// ...
using Serilog;

var builder = WebApplication.CreateBuilder(args);

builder.Logging.AddSerilog(new LoggerConfiguration()
    .Enrich.WithUpn()
    .Enrich.WithDisplayName()
    .Enrich.WithTenantId()
    .Enrich.WithObjectId()
    .Enrich.WithAppId()
    .Enrich.WithCustomClaim("AnyExistingClaim")
    .CreateLogger());

var app = builder.Build();
app.UseSerilogRequestLogging();
// ...
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  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 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 is compatible. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Serilog.Enrichers.AzureClaims:

Package Downloads
Intility.Logging.AspNetCore

This package enables common logging infrastructure to any aspnet or dotnet project using generic host mechanism. Additional logging capabilities are available through the extension packages Intility.Extensions.Logging.*

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.1.1 288 11/22/2024
1.1.1-rc.2 53 11/22/2024
1.1.1-rc.1 58 11/22/2024
1.1.1-rc.0 56 11/22/2024
1.1.0 89 11/21/2024
1.0.3 10,187 1/10/2024
1.0.2 33,816 11/16/2023
1.0.1 7,625 7/11/2023
1.0.1-tags-v1-0-1-rc--0001 152 7/11/2023
1.0.0 184 7/11/2023
0.1.2 298 6/28/2023
0.1.1 630 6/27/2023
0.1.0 152 6/27/2023

https://github.com/Intility/serilog-enrichers-azureclaims/releases