Fhi.ClientCredentialsKeypairs 1.2.0

.NET 6.0
dotnet add package Fhi.ClientCredentialsKeypairs --version 1.2.0
NuGet\Install-Package Fhi.ClientCredentialsKeypairs -Version 1.2.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="Fhi.ClientCredentialsKeypairs" Version="1.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Fhi.ClientCredentialsKeypairs --version 1.2.0
#r "nuget: Fhi.ClientCredentialsKeypairs, 1.2.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.
// Install Fhi.ClientCredentialsKeypairs as a Cake Addin
#addin nuget:?package=Fhi.ClientCredentialsKeypairs&version=1.2.0

// Install Fhi.ClientCredentialsKeypairs as a Cake Tool
#tool nuget:?package=Fhi.ClientCredentialsKeypairs&version=1.2.0

Client Credentials Usage

Configuration file section

  1. Add the following configuration section to your appsettings.json files, and populate it appropriately.
  "ClientCredentialsConfiguration": {
    "clientName": "",
    "authority": "",
    "clientId": "",
    "grantTypes": [ "client_credentials" ],
    "scopes": [ ],
    "secretType": "private_key_jwt:RsaPrivateKeyJwtSecret",
    "rsaPrivateKey": "",
    "rsaKeySizeBits": 4096,
    "privateJwk": "",
    "Apis": [
        "Name": "", // Tip:  Use nameof(YourService)
        "Url": ""
    "refreshTokenAfterMinutes":  8  // Set approx 20% less than lifetime of access token

Client Credentials using Keypairs

  1. Add package 'Fhi.ClientCredentialsKeypairs' to your project

  2. In your Program.cs file, or if older Startup.cs, add the following code section (for the outgoing interfaces):

    var clientCredentialsConfiguration = services.AddClientCredentialsKeypairs(Configuration);
    services.AddHttpClient(nameof(YourService), c =>
       c.Timeout = new TimeSpan(0, 0, 0, 10);
       c.BaseAddress = clientCredentialsConfiguration.UriToApiByName(nameof(YourService));
    .AddTypedClient(c => RestService.For<IExternalApi>(c, new RefitSettings
       ContentSerializer = new SystemTextJsonContentSerializer(services.DefaultJsonSerializationOptions())

replacing YourService with the service you have done for accessing the external api, and replace IExternalApi with the Refit interface for whatever external api you want to access.

For usages of Refit that uses an interface (in this example IMyService is the interface that Refit will implement), the code would look something like this:

    .ConfigureHttpClient(c =>
        c.BaseAddress = clientCredentialsConfiguration.UriToApiByName(nameof(IMyService));

The Configuration property is the injected IConfiguration property from the Startup.cs file.

If you don't use Refit, you can just skip the last part, and get the named client from the injected HttpFactory in your service. It will still have the authenticationhandler, so you don't need to do anything more there to get the bearer token. It will be added automatically.

Client Credentials using Client Secrets

If you want to disable the authorization for some reason, you can add another property named Enable to the ClientCredentialsConfiguration, it is default true.

  1. Add package Fhi.ClientCredentialsUsingSecrets to your project
  2. In your Program.cs file, create an instance of the ClientCredentialsSetup class using an IConfiguration parameter.
  3. Using the created instance call the method ConfigureServices.
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-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Fhi.ClientCredentialsKeypairs:

Package Downloads

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.2.0 1,177 8/19/2023
1.1.0 1,389 8/9/2023
1.0.0 3,618 2/16/2023
1.0.0-beta.5 99 2/15/2023
1.0.0-beta.4 80 2/15/2023
1.0.0-beta.3 79 2/15/2023
1.0.0-beta.2 85 2/14/2023
1.0.0-beta.1 320 11/15/2022
1.0.0-alpha.4 165 11/4/2022