BlogDoFT.Libs.Keycloak
1.14.0
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package BlogDoFT.Libs.Keycloak --version 1.14.0
NuGet\Install-Package BlogDoFT.Libs.Keycloak -Version 1.14.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="BlogDoFT.Libs.Keycloak" Version="1.14.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="BlogDoFT.Libs.Keycloak" Version="1.14.0" />
<PackageReference Include="BlogDoFT.Libs.Keycloak" />
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 BlogDoFT.Libs.Keycloak --version 1.14.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: BlogDoFT.Libs.Keycloak, 1.14.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 BlogDoFT.Libs.Keycloak@1.14.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=BlogDoFT.Libs.Keycloak&version=1.14.0
#tool nuget:?package=BlogDoFT.Libs.Keycloak&version=1.14.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
BlogDoFT.Libs.Keycloak
Client-credentials Keycloak token provider and a DelegatingHandler to attach Bearer tokens to outgoing HTTP requests. Registers IKeycloakTokenProvider (from BlogDoFT.Libs.Keycloak.Abstractions) as a typed HttpClient and caches the access token until shortly before it expires.
Purpose
- Fetch and cache an access token from Keycloak using the
client_credentialsgrant. - Provide
KeycloakAuthenticationHandler, aDelegatingHandlerthat attaches the cached token to anyHttpClientit decorates.
Configuration
{
"Keycloak": {
"TokenEndpoint": "https://keycloak.example.com/realms/demo/protocol/openid-connect/token",
"ClientId": "my-client",
"ClientSecret": "my-secret"
}
}
Quick start
// Composition root
services.AddKeycloakTokenProvider();
// or configure options in code
services.AddKeycloakTokenProvider(options =>
{
options.TokenEndpoint = "https://keycloak.example.com/realms/demo/protocol/openid-connect/token";
options.ClientId = "my-client";
options.ClientSecret = "my-secret";
});
Authenticating another HttpClient
services
.AddHttpClient("downstream-client")
.AddHttpMessageHandler<KeycloakAuthenticationHandler>();
Notes
AddKeycloakTokenProviderfails fast with anOptionsValidationExceptionwhenKeycloak:TokenEndpoint,Keycloak:ClientIdorKeycloak:ClientSecretis missing or empty.KeycloakAuthenticationHandleris registered so it can be attached to otherHttpClientregistrations (e.g. the Flagr client fromBlogDoFT.Libs.Flagr) viaAddHttpMessageHandler<KeycloakAuthenticationHandler>(); it is never automatically applied to the token-provider's own client, since fetching a token cannot depend on already having one.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | 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.
-
net10.0
- BlogDoFT.Libs.Keycloak.Abstractions (>= 1.14.0)
- Microsoft.Extensions.Configuration (>= 10.0.12)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.12)
- Microsoft.Extensions.Http (>= 10.0.12)
- Microsoft.Extensions.Options.ConfigurationExtensions (>= 10.0.12)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.