Keycloak.AuthServices.Sdk.Kiota 24.0.1

Prefix Reserved

There is a newer version of this package available.
See the version list below for details.

dotnet add package Keycloak.AuthServices.Sdk.Kiota --version 24.0.1

NuGet\Install-Package Keycloak.AuthServices.Sdk.Kiota -Version 24.0.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="Keycloak.AuthServices.Sdk.Kiota" Version="24.0.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Keycloak.AuthServices.Sdk.Kiota --version 24.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Keycloak.AuthServices.Sdk.Kiota, 24.0.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 Keycloak.AuthServices.Sdk.Kiota as a Cake Addin
#addin nuget:?package=Keycloak.AuthServices.Sdk.Kiota&version=24.0.1

// Install Keycloak.AuthServices.Sdk.Kiota as a Cake Tool
#tool nuget:?package=Keycloak.AuthServices.Sdk.Kiota&version=24.0.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Keycloak.AuthServices

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

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

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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- Keycloak.AuthServices.Common (>= 2.0.0)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Kiota.Abstractions (>= 1.7.11)
- Microsoft.Kiota.Authentication.Azure (>= 1.1.4)
- Microsoft.Kiota.Http.HttpClientLibrary (>= 1.3.7)
- Microsoft.Kiota.Serialization.Form (>= 1.1.5)
- Microsoft.Kiota.Serialization.Json (>= 1.1.8)
- Microsoft.Kiota.Serialization.Multipart (>= 1.1.3)
- Microsoft.Kiota.Serialization.Text (>= 1.1.4)

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
25.0.0	10,225	6/15/2024
25.0.0-hotfix.1	104	8/19/2024
24.0.4	1,785	5/16/2024
24.0.1	280	5/5/2024

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