🚀 A powerful and feature-rich .NET Core client library for Keycloak that simplifies integration with Keycloak's authentication and authorization services. This enterprise-ready library provides a comprehensive implementation of Keycloak's REST API, with full support for OpenID Connect, OAuth 2.0, and User-Managed Access (UMA 2.0) protocols.

• 🔄 Complete Keycloak REST API integration
• 🛡️ Robust security with OpenID Connect and OAuth 2.0
• 📊 Built-in monitoring and performance metrics
• 🔍 Comprehensive error handling and debugging
• 🚦 Automated token management and renewal
• 👥 Advanced user and group management
• 🔑 Multiple authentication flows support
• 📈 Enterprise-grade scalability

• 🔐 Keycloak Client for .NET Core
  • ⚙️ Requirements
  • ✅ Version Compatibility
  • 🌟 Key Features
  • 📚 Table of Contents
  • 💻 Installation
  • 🚀 Getting Started
    • 📋 Prerequisites
    • 🔧 Basic Setup
  • 📖 Basic Usage
  • 📚 Documentation
  • 🧪 Testing
    • 📋 Test Documentation
    • 🔬 Key Testing Features
    • ⚡ Running Tests
  • 🤝 Contributing
  • 📄 License

To integrate the Keycloak client library into your .NET Core application, simply add the NuGet package:

Install-Package Keycloak.NETCore.Client

• ✳️ .NET Core SDK (version 6.0 or later)
• 🖥️ A running Keycloak instance
• 🔑 Client credentials and realm configuration

1. Add the Keycloak client to your services in Program.cs or Startup.cs:

services.AddKeycloakAuthentication(options =>
{
    options.KeycloakBaseUrl = "http://localhost:8080";
    options.RealmAdminCredentials = new KcClientCredentials
    {
        ClientId = "your-client-id",
        ClientSecret = "your-client-secret"
    };
});

Here's a quick example of how to use the library:

// Create Keycloak client
var keycloakClient = new KeycloakClient("http://localhost:8080");

// Authenticate
var token = await keycloakClient.Auth.GetClientCredentialsTokenAsync(
    "your-realm",
    new KcClientCredentials
    {
        ClientId = "your-client-id",
        ClientSecret = "your-client-secret"
    });

// Use the token for other operations
var users = await keycloakClient.Users.GetAsync(
    "your-realm",
    token.AccessToken,
    new KcUserFilter { MaxResults = 10 });

Explore our comprehensive documentation for each module:

• 🔐 API Authentication

  • JWT Bearer Authentication
  • Role Claims Transformation
  • Security Best Practices

• 🛡️ Authorization

  • UMA 2.0 Authorization
  • Policy Enforcement
  • Protected Resources

• 📊 Response Types

  • Type-safe responses
  • Error handling
  • Response Models

• 📈 Monitoring and Metrics

  • Performance tracking
  • Health checks
  • System diagnostics

• 🔑 Authentication Management

  • Token lifecycle
  • Multiple auth flows
  • Security features

• 👥 User Management

  • User operations
  • Role management
  • Group handling

• ⚙️ Client Management

  • Configuration
  • Service accounts
  • Client scopes

Our library includes an extensive test suite ensuring reliability across multiple Keycloak versions (20.x through 26.x). The testing infrastructure leverages Docker and Ansible for automated setup and execution.

• 📘 Test Suite Guide

  • Test patterns
  • Setup instructions
  • Mock data structure

• 🔧 Ansible Setup Guide

  • Environment setup
  • Configuration management
  • Container orchestration

1. Version Coverage:

   • Supports Keycloak 20.x through 26.x
   • Automated environment setup per version
   • Parallel version testing

2. Test Categories:

   • Authentication flows
   • Authorization mechanisms
   • Client operations
   • Group management
   • User operations

3. Infrastructure:

   • Docker-based environments
   • Ansible automation
   • Continuous Integration ready
   • Comprehensive mock data

# Install test environment dependencies
cd NETCore.Keycloak.Client.Tests
make install_virtual_env

# Run tests for all supported versions
dotnet cake e2e_test.cake

We welcome contributions! Please see our Contributing Guidelines for details on how to submit pull requests, report issues, and contribute to the project.

This project is licensed under the MIT License - see the LICENSE file for details.

⭐ Star us on GitHub | 📫 Report Issues | 📚 Read the Docs