Skip to content
This repository has been archived by the owner on Jul 26, 2018. It is now read-only.

Latest commit

 

History

History
74 lines (43 loc) · 3.52 KB

README.md

File metadata and controls

74 lines (43 loc) · 3.52 KB

.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.

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.