FJesus.Refit.OAuth2
1.0.1
dotnet add package FJesus.Refit.OAuth2 --version 1.0.1
NuGet\Install-Package FJesus.Refit.OAuth2 -Version 1.0.1
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="FJesus.Refit.OAuth2" Version="1.0.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FJesus.Refit.OAuth2" Version="1.0.1" />
<PackageReference Include="FJesus.Refit.OAuth2" />
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 FJesus.Refit.OAuth2 --version 1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: FJesus.Refit.OAuth2, 1.0.1"
#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 FJesus.Refit.OAuth2@1.0.1
#: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=FJesus.Refit.OAuth2&version=1.0.1
#tool nuget:?package=FJesus.Refit.OAuth2&version=1.0.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Refit.OAuth2
Simple helpers for integrating Refit clients with OAuth2 authentication without relying on IdentityModel or Duende packages.
The NuGet package is published as FJesus.Refit.OAuth2.
Features
- Supports all standard OAuth2 flows including client credentials, authorization code, resource owner password and refresh token. Custom grant types can also be used via a generic provider.
DelegatingHandlerthat automatically attaches Bearer tokens.- Extension methods for registering Refit clients with OAuth2.
- Available extension methods:
AddOAuth2ClientCredentialsAddOAuth2AuthorizationCodeAddOAuth2ResourceOwnerPasswordAddOAuth2RefreshTokenAddOAuth2Custom
Usage
var services = new ServiceCollection();
var tokenHttpClient = new HttpClient();
services
.AddRefitClient<IMyApi>()
.ConfigureHttpClient(c => c.BaseAddress = new Uri("https://api.example.com"))
.AddOAuth2ClientCredentials(
tokenHttpClient,
tokenEndpoint: "https://auth.example.com/connect/token",
clientId: "client-id",
clientSecret: "client-secret",
scopes: new[] { "api.read" },
additionalHeaders: new Dictionary<string, string>
{
["X-Custom-Header"] = "value"
});
// Optionally customize the loggers
services
.AddRefitClient<IOtherApi>()
.AddOAuth2ClientCredentials(
tokenHttpClient,
"https://auth.example.com/connect/token",
"client-id",
"client-secret",
loggerFactory: LoggerFactory.Create(b => b.AddConsole()));
// Authorization code flow example
services
.AddRefitClient<IAuthApi>()
.AddOAuth2AuthorizationCode(
tokenHttpClient,
"https://auth.example.com/connect/token",
"client-id",
"client-secret",
code: "the-code-from-auth-server",
redirectUri: "https://app/callback");
var provider = services.BuildServiceProvider();
var client = provider.GetRequiredService<IMyApi>();
Building a NuGet package
To create a package for distribution run:
dotnet pack src/Refit.OAuth2/Refit.OAuth2.csproj -c Release
The resulting .nupkg file will be placed in the bin/Release directory and
can be published to a NuGet feed.
This library aims to be compliant with the OAuth2 specification and can be extended with custom grant types if needed.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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-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 was computed. 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. |
| .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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
.NETStandard 2.0
- Microsoft.Extensions.Http (>= 8.0.0)
- Refit (>= 8.0.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.