i28511.Hattrick.OAuth 4.0.0

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

// Install i28511.Hattrick.OAuth as a Cake Tool
#tool nuget:?package=i28511.Hattrick.OAuth&version=4.0.0


This class library provides an easy-to-use implementation of OAuth authentication and authorization for the Hattrick CHPP XML API. It leverages the power of Microsoft's Dependency Injection framework to allow developers to add OAuth functionality to their applications with minimal code and configuration. The library is compatible with .NET 7.0 and Microsoft.Extensions.DependencyInjection.Abstractions, making it a great choice for modern .NET applications. With this library, you can authenticate and authorize your requests to the Hattrick API with just a few lines of code, making it an indispensable tool for anyone working with this API.


You can install the library via NuGet by running the following command in the Package Manager Console:

Install-Package i28511.Hattrick.OAuth

Usage Example

To use the library, you will need to add the following line to your Startup.cs file:

OAuthServiceConfiguration oauthConfig = new OAuthServiceConfiguration
    ConsumerKey = Configuration.GetValue<string>("OAuth:ClientId"),
    ConsumerSecret = Configuration.GetValue<string>("OAuth:ClientSecret"),
    CallbackUrl = new Uri(Configuration.GetValue<string>("OAuth:CallbackUrl"))

This will add the IOAuthService and OAuthService to your service collection with the given configuration.

You will also need to configure the OAuth settings in your appsettings.json file. An example configuration is provided below:

	"OAuth": {
		"ClientId": "YOUR_CLIENT_ID",
		"ClientSecret": "YOUR_CLIENT_SECRET",
		"CallbackUrl": "YOUR_CALLBACK_URL"

You can then inject the IOAuthService into your controllers or services and use it to authenticate and authorize requests to the Hattrick API.

Methods and Authentication flow

Call the RequestTokenAsync method, passing in a CancellationToken object, to request an OAuth token. This method returns an OAuthRequestResult object, which contains the authorize URL and token secret.

Use the authorize URL to login into Hattrick. The callbackUrl defined will be called, and the token and verifier will be on the query string (you will need them in the next call).

Call the AuthorizeAsync method, passing in the token, verifier, secret (token secret from the RequestToken result), and a CancellationToken object, to authorize the OAuth request.

This method returns an OAuthAuthorizeResult object, which contains the token and secret that can be used from now on.

In case of any OAuth errors, the methods may throw an OAuthException exception, with the error description provided in the exception message.

OAuth Scopes

The library implements the following scopes to authorize requests to the Hattrick API:

  • manage_challenges
  • set_matchorder
  • manage_youthplayers
  • set_training
  • place_bid


This library is compatible with the following frameworks:

  • net7.0
  • Microsoft.Extensions.DependencyInjection.Abstractions (>= 7.0.0)
  • OAuth.DotNetCore (>= 3.0.1)

To use this library on a different framework, you may need to specify compatible versions of the NuGet packages used in the project.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  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

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
4.0.0 210 2/7/2023
3.4.1 198 2/7/2023
3.4.0 213 2/7/2023
3.3.0 213 2/7/2023