Clerk.Net
1.6.0
dotnet add package Clerk.Net --version 1.6.0
NuGet\Install-Package Clerk.Net -Version 1.6.0
<PackageReference Include="Clerk.Net" Version="1.6.0" />
paket add Clerk.Net --version 1.6.0
#r "nuget: Clerk.Net, 1.6.0"
// Install Clerk.Net as a Cake Addin #addin nuget:?package=Clerk.Net&version=1.6.0 // Install Clerk.Net as a Cake Tool #tool nuget:?package=Clerk.Net&version=1.6.0
Clerk SDK for .NET
Looking for ASP.NET Core w/ Clerk JWTs? See below.
Packages
Clerk.Net
: Provides the standalone API Client as a Kiota-generated wrapper over Clerk's OpenAPI spec. Compatible with .NET 6+ and .NET Framework 4.7.2+.
Clerk.Net.DependencyInjection
: Extensions to register the ClerkApiClient
into your DI container. Compatible with .NET 6+.
These libraries are configured as native AoT compatible for .NET 8+ consumers.
Getting Started
Make sure to add your SecretKey
to your application configuration, ideally via the dotnet secrets manager.
DI Container Configuration (ASP.NET Core & Worker Services)
- Install
Clerk.Net.DependencyInjection
from Nuget. - Add the following code to your service configuration:
builder.Services.AddClerkApiClient(config =>
{
config.SecretKey = builder.Configuration["Clerk:SecretKey"]!
});
- Request the
ClerkApiClient
in your services
public class MyBackgroundWorker : BackgroundService
{
private readonly ClerkApiClient _clerkApiClient;
public MyBackgroundWorker(ClerkApiClient clerkApiClient)
{
_clerkApiClient = clerkApiClient;
}
protected override async Task ExecuteAsync(CancellationToken stoppingToken)
{
var invites = await _clerkApiClient.Organizations["org_abc1234"].Invitations.GetAsync(x =>
{
x.QueryParameters.Status = "pending";
});
}
}
Standalone Client
If you want to use the client by itself, install Clerk.Net
and call ClerkApiClientFactory.Create
, passing in your secret key.
The returned client should be treated as a singleton and created once for the lifetime of your application.
HttpClient Customization
If you need to configure the underlying HttpClient
used by the client, you can do in one of two ways:
- Configure the
IHttpClientBuilder
returned byAddClerkApiClient
. - Pass in a custom
HttpClient
instance toClerkApiClientFactory.Create
Testing
For unit testing, see Unit testing Kiota API clients.
What about JWT Auth?
You might have stumbled upon this repo looking for a solution for validating Clerk JWTs, so I'll include the answer here for completion. Configuring JWT auth for Clerk is a tad unusual as they want you to validate the azp
parameter instead of specifying an audience
.
This claim isn't normally validated at the authentication layer, and so you'll need some extra code to get things working:
builder.Services.AddAuthentication(JwtBearerDefaults.AuthenticationScheme)
.AddJwtBearer(x =>
{
// Authority is the URL of your clerk instance
x.Authority = builder.Configuration["Clerk:Authority"];
x.TokenValidationParameters = new TokenValidationParameters()
{
// Disable audience validation as we aren't using it
ValidateAudience = false,
NameClaimType = ClaimTypes.NameIdentifier
};
x.Events = new JwtBearerEvents()
{
// Additional validation for AZP claim
OnTokenValidated = context =>
{
var azp = context.Principal?.FindFirstValue("azp");
// AuthorizedParty is the base URL of your frontend.
if (string.IsNullOrEmpty(azp) || !azp.Equals(builder.Configuration["Clerk:AuthorizedParty"]))
context.Fail("AZP Claim is invalid or missing");
return Task.CompletedTask;
}
};
});
Your frontend should call Clerk-JS's getToken
as part of its HTTP middleware and append the token (prefixed with Bearer
) to the Authorization
header, for example:
async onRequestInit({ requestInit }) {
requestInit.headers = {
...requestInit.headers,
Authorization: `Bearer ${await getToken()}`
}
}
Disclaimer
I am not affiliated with nor represent Clerk. All support queries regarding the underlying service should go to Clerk Support.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. 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 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETStandard 2.0
- Microsoft.Kiota.Abstractions (>= 1.9.7)
- Microsoft.Kiota.Http.HttpClientLibrary (>= 1.4.3)
- Microsoft.Kiota.Serialization.Form (>= 1.2.5)
- Microsoft.Kiota.Serialization.Json (>= 1.3.3)
- Microsoft.Kiota.Serialization.Multipart (>= 1.1.5)
- Microsoft.Kiota.Serialization.Text (>= 1.2.2)
-
net6.0
- Microsoft.Kiota.Abstractions (>= 1.9.7)
- Microsoft.Kiota.Http.HttpClientLibrary (>= 1.4.3)
- Microsoft.Kiota.Serialization.Form (>= 1.2.5)
- Microsoft.Kiota.Serialization.Json (>= 1.3.3)
- Microsoft.Kiota.Serialization.Multipart (>= 1.1.5)
- Microsoft.Kiota.Serialization.Text (>= 1.2.2)
-
net8.0
- Microsoft.Kiota.Abstractions (>= 1.9.7)
- Microsoft.Kiota.Http.HttpClientLibrary (>= 1.4.3)
- Microsoft.Kiota.Serialization.Form (>= 1.2.5)
- Microsoft.Kiota.Serialization.Json (>= 1.3.3)
- Microsoft.Kiota.Serialization.Multipart (>= 1.1.5)
- Microsoft.Kiota.Serialization.Text (>= 1.2.2)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Clerk.Net:
Package | Downloads |
---|---|
Clerk.Net.DependencyInjection
Clerk Backend API Wrapper for .NET. This package includes dependency injection extensions. |
GitHub repositories
This package is not used by any popular GitHub repositories.