Keycloak.AuthServices.Authorization 2.0.0-pre-4

Prefix Reserved
.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
This is a prerelease version of Keycloak.AuthServices.Authorization.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package Keycloak.AuthServices.Authorization --version 2.0.0-pre-4
                    


                    

                
NuGet\Install-Package Keycloak.AuthServices.Authorization -Version 2.0.0-pre-4
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="Keycloak.AuthServices.Authorization" Version="2.0.0-pre-4" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Keycloak.AuthServices.Authorization" Version="2.0.0-pre-4" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Keycloak.AuthServices.Authorization" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Keycloak.AuthServices.Authorization --version 2.0.0-pre-4
                    


                    

                
#r "nuget: Keycloak.AuthServices.Authorization, 2.0.0-pre-4"
#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. 
#:package Keycloak.AuthServices.Authorization@2.0.0-pre-4
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Keycloak.AuthServices.Authorization&version=2.0.0-pre-4&prerelease
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Keycloak.AuthServices.Authorization&version=2.0.0-pre-4&prerelease
                    


                            Install as a Cake Tool

Keycloak.AuthServices

Build CodeQL NuGet contributionswelcome Conventional Commits License

Easy Authentication and Authorization with Keycloak in .NET and ASP.NET Core.

Package Version Description
Keycloak.AuthServices.Authentication Nuget Keycloak Authentication JWT + OICD
Keycloak.AuthServices.Authorization Nuget Authorization Services. Use Keycloak as authorization server
Keycloak.AuthServices.Sdk Nuget HTTP API integration with Keycloak

GitHub Actions Build History

Documentation

See the docs: https://nikiforovall.github.io/keycloak-authorization-services-dotnet

Getting Started

Install packages:

dotnet add package Keycloak.AuthServices.Authentication
dotnet add package Keycloak.AuthServices.Common

// Program.cs
using Keycloak.AuthServices.Authentication; 

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddKeycloakWebApiAuthentication(builder.Configuration); 
builder.Services.AddAuthorization(); 

var app = builder.Build();

app.UseAuthentication(); 
app.UseAuthorization(); 

app.MapGet("/", () => "Hello World!").RequireAuthorization(); 

app.Run();

In this example, configuration is based on appsettings.json.

//appsettings.json
{
    "Keycloak": {
        "realm": "Test",
        "auth-server-url": "http://localhost:8080/",
        "ssl-required": "none",
        "resource": "test-client",
        "verify-token-audience": false,
        "credentials": {
        "secret": ""
        },
        "confidential-port": 0
    }
}

Example Authorization

With Keycloak.AuthServices.Authorization, you can implement role-based authorization in your application. This package allows you to define policies based on roles. Also, you can use Keycloak as Authorization Server. It is a powerful way to organize and apply authorization polices centrally.

var builder = WebApplication.CreateBuilder(args);

var host = builder.Host;
var configuration = builder.Configuration;
var services = builder.Services;

services.AddKeycloakWebApiAuthentication(configuration);

services.AddAuthorization(options =>
    {
        options.AddPolicy("AdminAndUser", builder =>
        {
            builder
                .RequireRealmRoles("User") // Realm role is fetched from token
                .RequireResourceRoles("Admin"); // Resource/Client role is fetched from token
        });
    })
    .AddKeycloakAuthorization(configuration);

var app = builder.Build();

app.UseAuthentication();
app.UseAuthorization();

app.MapGet("/hello", () => "[]")
    .RequireAuthorization("AdminAndUser");

app.Run();

Build and Development

dotnet cake --target build

dotnet cake --target test

dotnet pack -o ./Artefacts

Blog Posts

For more information and real world examples, please see my blog posts related to Keycloak and .NET https://nikiforovall.github.io/tags.html#keycloak-ref

Reference

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 was computed.  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.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (14)

Showing the top 5 NuGet packages that depend on Keycloak.AuthServices.Authorization:

Package Downloads
Gathrr.Framework.Infrastructure

Package Description
Feijuca.Auth

Feijuca.Auth simplifies Keycloak integration for user management and multi-tenancy. It features TokenManager for centralized API calls to manage users and auth services for handling multiple tenants using Keycloak realms. Check the documentation for more details!
Wcz.Layout

Package Description
Iskra.Core.Auth

Настройка авторизации в Keycloak.
Iskra.Core.ApiDocumentation

Формирование Swagger документации с настройкой авторизации.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.7.0 21,395 9/4/2025
2.6.1 142,569 3/13/2025
2.6.0 145,983 11/30/2024
2.5.5 14,141 11/27/2024
2.5.3 245,885 8/19/2024
2.5.2 130,983 6/15/2024
2.5.1 5,704 6/11/2024
2.5.0 12,551 6/2/2024
2.4.1 19,424 5/16/2024
2.4.0 1,489 5/12/2024
2.3.0 503 5/10/2024
2.3.0-pre-1 134 5/9/2024
2.2.1 1,178 5/9/2024
2.2.0 329 5/8/2024
2.1.0 3,640 5/7/2024
2.0.0 5,191 5/5/2024
2.0.0-pre-4 154 5/4/2024
2.0.0-pre-3 257 4/26/2024
2.0.0-pre-2 165 4/25/2024
2.0.0-pre-1 427 4/24/2024
1.6.0 352,347 10/25/2023
1.5.2 201,010 5/27/2023
1.5.1 274,852 1/17/2023
1.5.0 682 1/17/2023
1.4.1 4,063 1/12/2023
1.4.0 5,608 1/4/2023
1.3.0 1,838 12/28/2022
1.2.1 39,088 9/22/2022
1.2.0 2,886 8/24/2022
1.1.0 13,339 1/30/2022
1.0.5 188 1/29/2022
1.0.4 181 1/28/2022
1.0.3 161 1/28/2022
1.0.2 175 1/23/2022
1.0.1 736 1/19/2022
1.0.0 5,447 1/19/2022

The release notes are available at https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/releases