Keycloak.Net.Sdk.Aspire 1.0.0

dotnet add package Keycloak.Net.Sdk.Aspire --version 1.0.0
                    
NuGet\Install-Package Keycloak.Net.Sdk.Aspire -Version 1.0.0
                    
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.Net.Sdk.Aspire" Version="1.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Keycloak.Net.Sdk.Aspire" Version="1.0.0" />
                    
Directory.Packages.props
<PackageReference Include="Keycloak.Net.Sdk.Aspire" />
                    
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.Net.Sdk.Aspire --version 1.0.0
                    
#r "nuget: Keycloak.Net.Sdk.Aspire, 1.0.0"
                    
#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.Net.Sdk.Aspire@1.0.0
                    
#: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.Net.Sdk.Aspire&version=1.0.0
                    
Install as a Cake Addin
#tool nuget:?package=Keycloak.Net.Sdk.Aspire&version=1.0.0
                    
Install as a Cake Tool

Keycloak.Net.Sdk.Aspire

.NET Aspire client integration for Keycloak.Net.Sdk. Wires the SDK into a dependent project using the Keycloak server URL injected by Aspire — no manual appsettings.json URL needed.


Installation

dotnet add package Keycloak.Net.Sdk.Aspire

Usage

// MyApi/Program.cs
builder.AddKeycloakSdk();

AddKeycloakSdk reads ConnectionStrings__keycloak (injected by Aspire via WithReference) and uses it as ServerUrl. The remaining settings come from appsettings.json:

"keycloak": {
  "RealmName": "my-realm",
  "ClientId": "my-client",
  "ClientSecret": "my-secret",
  "ClientUuid": "my-uuid",
  "AdminUsername": "admin",
  "AdminPassword": "admin"
}

Custom Resource Name or Overrides

// If the AppHost resource is named differently
builder.AddKeycloakSdk("auth-server");

// Override any setting programmatically
builder.AddKeycloakSdk(configure: cfg => cfg.NumberOfRetries = 5);

For the AppHost setup see Keycloak.Net.Sdk.Aspire.Hosting.
Full documentation: github.com/MiladRv/Keycloak.Net

Product Compatible and additional computed target framework versions.
.NET 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 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 is compatible.  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

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
1.0.0 78 6/9/2026