Keycloak.AuthServices.Sdk.Kiota
26.0.5
Prefix Reserved
dotnet add package Keycloak.AuthServices.Sdk.Kiota --version 26.0.5
NuGet\Install-Package Keycloak.AuthServices.Sdk.Kiota -Version 26.0.5
<PackageReference Include="Keycloak.AuthServices.Sdk.Kiota" Version="26.0.5" />
paket add Keycloak.AuthServices.Sdk.Kiota --version 26.0.5
#r "nuget: Keycloak.AuthServices.Sdk.Kiota, 26.0.5"
// Install Keycloak.AuthServices.Sdk.Kiota as a Cake Addin #addin nuget:?package=Keycloak.AuthServices.Sdk.Kiota&version=26.0.5 // Install Keycloak.AuthServices.Sdk.Kiota as a Cake Tool #tool nuget:?package=Keycloak.AuthServices.Sdk.Kiota&version=26.0.5
Keycloak.AuthServices
π Easy Authentication and Authorization with Keycloak in .NET.
Documentation
For Developer Documentation see: https://nikiforovall.github.io/keycloak-authorization-services-dotnet
API Reference
See: https://nikiforovall.github.io/keycloak-authorization-services-dotnet-docs
Getting Started
Install packages:
dotnet add package Keycloak.AuthServices.Authentication
// 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 - Add 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();
Example - Invoke Admin API
var services = new ServiceCollection();
services.AddKeycloakAdminHttpClient(new KeycloakAdminClientOptions
{
AuthServerUrl = "http://localhost:8080/",
Realm = "master",
Resource = "admin-api",
});
var sp = services.BuildServiceProvider();
var client = sp.GetRequiredService<IKeycloakRealmClient>();
var realm = await client.GetRealmAsync("Test");
Build and Development
dotnet cake --target build
dotnet cake --target test
dotnet pack -o ./Artefacts
Product | Versions 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. |
-
net6.0
- Keycloak.AuthServices.Common (>= 2.5.5)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Kiota.Abstractions (>= 1.14.0)
- Microsoft.Kiota.Authentication.Azure (>= 1.14.0)
- Microsoft.Kiota.Http.HttpClientLibrary (>= 1.14.0)
- Microsoft.Kiota.Serialization.Form (>= 1.14.0)
- Microsoft.Kiota.Serialization.Json (>= 1.14.0)
- Microsoft.Kiota.Serialization.Multipart (>= 1.14.0)
- Microsoft.Kiota.Serialization.Text (>= 1.14.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Keycloak.AuthServices.Sdk.Kiota:
Package | Downloads |
---|---|
Iskra.Core.ApiDocumentation
Π€ΠΎΡΠΌΠΈΡΠΎΠ²Π°Π½ΠΈΠ΅ Swagger Π΄ΠΎΠΊΡΠΌΠ΅Π½ΡΠ°ΡΠΈΠΈ Ρ Π½Π°ΡΡΡΠΎΠΉΠΊΠΎΠΉ Π°Π²ΡΠΎΡΠΈΠ·Π°ΡΠΈΠΈ. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
26.0.5 | 711 | 11/27/2024 |
25.0.0 | 13,671 | 6/15/2024 |
25.0.0-hotfix.1 | 110 | 8/19/2024 |
24.0.4 | 1,897 | 5/16/2024 |
24.0.1 | 356 | 5/5/2024 |
The release notes are available at https://github.com/NikiforovAll/keycloak-authorization-services-dotnet/releases