.NET client for the Auth0 API
Clone or download
Latest commit 41c6384 Aug 30, 2018

README.md

.Net client library for the Auth0 platform.

Version 4.x is meant to be used for clients that are either flagged as OIDC Conformant (under the OAuth tab in the client Advanced settings) or if you are triggering the OIDC-conformant pipeline by using the audience parameter when starting an authorization flow.

If not, please continue using v3.x. Both version will be fully supported and mantained.

Changes

  • V4 contains some breaking changes (mostly to accomodate OIDC-conformant clients, but also fix some inconsistencies) and some new functionality. Changes are listed here.

Management API

Full Documentation

Full documentation on how to use this library can be found at http://auth0.github.io/auth0.net

Installation

Install-Package Auth0.ManagementApi

Usage

Generate a token for the API calls you wish to make (see https://auth0.com/docs/api/v2/tokens). Create an instance of the ManagementApiClient class with the token and the API URL of your Auth0 instance:

 var client = new ManagementApiClient("your token", new Uri("https://YOUR_AUTH0_DOMAIN/api/v2"));

The API calls are divided into groups which correlate to the Management API documentation. For example all Connection related methods can be found under the ManagementApiClient.Connections property. So to get a list of all database (Auth0) connections, you can make the following API call:

await client.Connections.GetAllAsync("auth0");

Authentication API

Installation

Install-Package Auth0.AuthenticationApi

Usage

To use the Authentication API, create a new instance of the AuthenticationApiClient class, passing in the URL of your Auth0 instance, e.g.:

var client = new AuthenticationApiClient(new Uri("https://YOUR_AUTH0_DOMAIN"));

Authentication

This library is contains URL Builders which will assist you with constructing an authentication URL, but does not actually handle the authentication/authorization flow for you. It is suggested that you refer to the Quickstart tutorials for guidance on how to implement authentication for your specific platform.

Important note on state validation: If you choose to use the AuthorizationUrlBuilder to construct the authorization URL and implement a login flow callback yourself, it is important to generate and store a state value (using WithState) and validate it in your callback URL before calling exchanging the authorization code for the tokens.

Documentation

For more information about auth0 visit our documentation page.

Building

This project can be built on Windows, Linux or macOS. Ensure you have the .NET Core SDK installed. You can also use the code editor of your choice or a full-blown IDE such as Visual Studio or Jetbrains Rider.

The full set of libraries can be built by running build.ps1 (on Windows) or build.sh on macOS / Linux. This will do a full compilation as well as execute the unit tests. You can run the unit tests individually by using the dotnet test command (see docs).

Building for release

Since this library also targets the full .NET Framework, you can currently only do a build for release on Windows.

  1. Ensure that you have updated the Major, Minor and Revision version numbers in /build/common.props for the new version.
  2. Also update the PackageReleaseNotes in the above-mentioned file with the release notes.
  3. Run build.ps1 and ensure that all the tests pass
  4. Run the command build.ps1 -Target Pack. This will perform a full Release build and create NuGet packages (*.nupkg) in the /artifacts folder.
  5. Upload the NuGet packages to NuGet using the nuget push command.

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Responsible Disclosure Program details the procedure for disclosing security issues.

Author

Auth0

License

This project is licensed under the MIT license. See the LICENSE file for more info.