OAuth2Authenticator 3.9.0
dotnet add package OAuth2Authenticator --version 3.9.0
NuGet\Install-Package OAuth2Authenticator -Version 3.9.0
<PackageReference Include="OAuth2Authenticator" Version="3.9.0" />
paket add OAuth2Authenticator --version 3.9.0
#r "nuget: OAuth2Authenticator, 3.9.0"
// Install OAuth2Authenticator as a Cake Addin #addin nuget:?package=OAuth2Authenticator&version=3.9.0 // Install OAuth2Authenticator as a Cake Tool #tool nuget:?package=OAuth2Authenticator&version=3.9.0
OAuth2Authenticator
OAuth2 client for retrieving OAuth2 tokens and common token handling logic such as refresh and client credentials.
Currently supported grant types
Setup
Initialize the client service in the application startup.
public void ConfigureServices(IServiceCollection services)
{
services.InitOAuth2Authenticator();
}
Usage
OAuth2Authenticator
This class holds the request logic for all OAuth2 grant types. Injectable over the IOAuth2Authenticator
interface.
private readonly IOAuth2Authenticator _authenticator;
await _authenticator.PasswordGrant(url, clientId, username, password);
await _authenticator.RefreshTokenGrant(url, clientId, refreshToken);
await _authenticator.ClientCredentialsGrant(url, clientId, clientSecret);
After the request, a OAuth2TokenResponse
or null
returns.
OAuth2TokenHandler
This class holds common logic which is needed for token handling. Injectable over the IOAuth2TokenHandler
interface.
RefreshHandler
The refresh handler checks whether the access token is about to expire or has already expired and automatically attempts to renew the token with the refresh token. If a renewal with the refresh token is not possible, a new token is retrieved via the specified callback. The handler always attempts to return a valid token.
private readonly IOAuth2TokenHandler _handler;
private static OAuth2TokenResponse token; // Save the last token somewhere static or distributed.
token = await _handler.RefreshHandler(
token,
url,
clientId,
async (url, clientId, cancellationToken) =>
{
// Is executed to obtain a new token if an refresh was not possible or none exists yet.
return await _authenticator.PasswordGrant(url, clientId, username, password);
});
ClientCredentialsHandler
The client credentials handler checks whether the access token is about to expire or has already expired and automatically requests a new token.
private readonly IOAuth2TokenHandler _handler;
private static OAuth2TokenResponse token; // Save the last token somewhere static or distributed.
token = await _handler.ClientCredentialsHandler(
token,
url,
clientId,
clientSecret);
OAuth2TokenResponseExtension
Checks if the token request was successful.
token.Successful()
Checks that the token is not expired.
token.Valid()
API Reference
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 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.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.3)
- System.Net.Http.Json (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
-
net8.0
- Microsoft.Extensions.Http (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Newtonsoft.Json (>= 13.0.3)
- System.Net.Http.Json (>= 8.0.0)
- System.Text.Json (>= 8.0.5)
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 |
---|---|---|
3.9.0 | 395 | 11/12/2024 |
3.8.1 | 78 | 11/12/2024 |
3.8.0 | 87 | 11/11/2024 |
3.7.2 | 1,447 | 6/18/2024 |
3.7.1 | 102 | 6/18/2024 |
3.7.0 | 111 | 6/18/2024 |
3.6.0 | 102 | 5/15/2024 |
3.5.0 | 2,631 | 12/6/2023 |
3.4.1 | 201 | 6/19/2023 |
3.4.0 | 4,030 | 2/17/2023 |
3.3.1 | 1,530 | 11/9/2022 |
3.3.0 | 1,481 | 9/19/2022 |
3.2.1 | 922 | 9/6/2022 |
3.2.0 | 1,776 | 7/26/2022 |
3.1.0 | 1,085 | 7/11/2022 |
3.0.0 | 1,283 | 5/30/2022 |
2.0.2 | 452 | 5/24/2022 |
2.0.1 | 403 | 5/24/2022 |
2.0.0 | 414 | 5/24/2022 |
1.0.0 | 425 | 5/23/2022 |