Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.
;
};
export const sections = [{
id: "configure-auth0",
title: "Configure Auth0"
}, {
id: "install-and-configure-the-sdk",
title: "Install and Configure the SDK"
}, {
id: "login",
title: "Login"
}, {
id: "display-user-profile",
title: "Display User Profile"
}, {
id: "logout",
title: "Logout"
}];
Auth0 allows you to quickly add authentication and gain access to user profile information in your application.
This guide demonstrates how to integrate Auth0 with any new or existing ASP.NET MVC application using the
**Auth0.AspNetCore.Authentication** SDK.
To use Auth0 services, you’ll need to have an application set up in the Auth0 Dashboard. The Auth0 application is
where you will configure how you want authentication to work for the project you are developing.
### Configure an application
Use the interactive selector to create a new Auth0 application or select an existing application that represents
the project you want to integrate with. Every application in Auth0 is assigned an alphanumeric, unique client ID
that your application code will use to call Auth0 APIs through the SDK.
Any settings you configure using this quickstart will automatically update for your Application in the [Dashboard](https://manage.auth0.com/#/), which is where you
can manage your Applications in the future.
If you would rather explore a complete configuration, you can view a sample application instead.
### Configure Callback URLs
A callback URL is a URL in your application that you would like Auth0 to redirect users to after they have
authenticated. If not set, users will not be returned to your application after they log in.
If you are following along with our sample project, set this to
`http://localhost:3000/callback`.
### Configure Logout URLs
A logout URL is a URL in your application that you would like Auth0 to redirect users to after they have logged
out. If not set, users will not be able to log out from your application and will receive an error.
If you are following along with our sample project, set this to `http://localhost:3000`.
### Install from Nuget
To integrate Auth0 with ASP.NET Core you can use our SDK by installing the
`Auth0.AspNetCore.Authentication` [Nuget package](https://www.nuget.org/packages/Auth0.AspNetCore.Authentication/) to your application.
### Configure the middleware
To enable authentication in your ASP.NET Core application, use the middleware provided by the SDK. Go to the
`Program.cs` file and call `builder.Services.AddAuth0WebAppAuthentication()` to register the
SDK's middleware.
Ensure to configure the `Domain` and `ClientId`, these are required fields to ensure the
SDK knows which Auth0 tenant and application it should use.
Make sure you have enabled authentication and authorization in your `Program.cs` file.
To allow users to login to your ASP.NET MVC application, add a `Login` action to your controller.
Call `HttpContext.ChallengeAsync()` and pass `Auth0Constants.AuthenticationScheme` as the
authentication scheme. This will invoke the OIDC authentication handler that our SDK registers internally. Be sure
to also specify the corresponding `authenticationProperties`, which you can construct using the
`LoginAuthenticationPropertiesBuilder`.
After succesfully calling `HttpContext.ChallengeAsync()`, the user will be redirected to Auth0 and
signed in to both the OIDC middleware and the cookie middleware upon being redirected back to your application.
This will allow the users to be authenticated on subsequent requests.
##### Checkpoint
Now that you have configured Login, run your application to verify that:
* Navigating to your `Login`action will redirect to Auth0
* Entering your credentials will redirect you back to your application.
After the middleware has successfully retrieved the tokens from Auth0, it will extract the user's information and
claims from the ID Token and makes them available as the `User.Claims` property on the controller.
You can create a custom user profile page for displaying a user's name, email address, and profile image, by
retrieving the corresponding information from the `User` and pass it to the view from inside your
controller.
##### Checkpoint
Now that you have set up your action to render the user's profile, run your application to verify that:
* Navigating to your `Profile`action after being succesfully logged in, shows the user's
profile.
Logging out the user from your own application can be done by calling `HttpContext.SignOutAsync` with
the `CookieAuthenticationDefaults.AuthenticationScheme` authentication scheme from inside your
controller's action.
Additionally, If you also want to log the user out from Auth0 (this might also log them out of other applications
that rely on Single Sign On), call `HttpContext.SignOutAsync` with the
`Auth0Constants.AuthenticationScheme` authentication scheme as well as the appropriate
`authenticationProperties` that can be constructed using the
`LogoutAuthenticationPropertiesBuilder`.
##### Checkpoint
Now that you have configured Logout, run your application to verify that:
* Navigating to your `Logout`action will ensure the user is logged out.
* When also logging out from Auth0, you should be redirected to Auth0 and instantly redirected back to
your own application.
## Next Steps
Excellent work! If you made it this far, you should now have login, logout, and user profile information running in your application.
This concludes our quickstart tutorial, but there is so much more to explore. To learn more about what you can do with Auth0, check out:
* [Auth0 Dashboard](https://manage.auth0.com/dashboard/us/dev-gja8kxz4ndtex3rq) - Learn how to configure and manage your Auth0 tenant and applications
* [auth0-aspnetcore-authentication SDK](https://github.com/auth0/auth0-aspnetcore-authentication) - Explore the SDK used in this tutorial more fully
* [Auth0 Marketplace](https://marketplace.auth0.com/) - Discover integrations you can enable to extend Auth0’s functionality
```json appsettings.json lines
{
"Auth0": {
"Domain": "dev-gja8kxz4ndtex3rq.us.auth0.com",
"ClientId": "mz9iNEIo2PHu7oeh8QRt19ndTyyCIgai"
}
}
```
```cs AccountController.cs lines
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.Cookies;
using Auth0.AspNetCore.Authentication;
public class AccountController : Controller
{
public async Task Login(string returnUrl = "/")
{
var authenticationProperties = new LoginAuthenticationPropertiesBuilder()
// Indicate here where Auth0 should redirect the user after a login.
// Note that the resulting absolute Uri must be added to the
// **Allowed Callback URLs** settings for the app.
.WithRedirectUri(returnUrl)
.Build();
await HttpContext.ChallengeAsync(
Auth0Constants.AuthenticationScheme,
authenticationProperties
);
}
[Authorize]
public IActionResult Profile()
{
return View(new
{
Name = User.Identity.Name,
EmailAddress = User.Claims
.FirstOrDefault(c => c.Type == ClaimTypes.Email)?.Value,
ProfileImage = User.Claims
.FirstOrDefault(c => c.Type == "picture")?.Value
});
}
[Authorize]
public async Task Logout()
{
var authenticationProperties = new LogoutAuthenticationPropertiesBuilder()
// Indicate here where Auth0 should redirect the user after a logout.
// Note that the resulting absolute Uri must be added to the
// **Allowed Logout URLs** settings for the app.
.WithRedirectUri(Url.Action("Index", "Home"))
.Build();
// Logout from Auth0
await HttpContext.SignOutAsync(
Auth0Constants.AuthenticationScheme,
authenticationProperties
);
// Logout from the application
await HttpContext.SignOutAsync(
CookieAuthenticationDefaults.AuthenticationScheme
);
}
}
```
```cs AccountController.cs lines
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authentication.Cookies;
using Auth0.AspNetCore.Authentication;
public class AccountController : Controller
{
public async Task Login(string returnUrl = "/")
{
var authenticationProperties = new LoginAuthenticationPropertiesBuilder()
// Indicate here where Auth0 should redirect the user after a login.
// Note that the resulting absolute Uri must be added to the
// **Allowed Callback URLs** settings for the app.
.WithRedirectUri(returnUrl)
.Build();
await HttpContext.ChallengeAsync(
Auth0Constants.AuthenticationScheme,
authenticationProperties
);
}
[Authorize]
public IActionResult Profile()
{
return View(new
{
Name = User.Identity.Name,
EmailAddress = User.Claims
.FirstOrDefault(c => c.Type == ClaimTypes.Email)?.Value,
ProfileImage = User.Claims
.FirstOrDefault(c => c.Type == "picture")?.Value
});
}
[Authorize]
public async Task Logout()
{
var authenticationProperties = new LogoutAuthenticationPropertiesBuilder()
// Indicate here where Auth0 should redirect the user after a logout.
// Note that the resulting absolute Uri must be added to the
// **Allowed Logout URLs** settings for the app.
.WithRedirectUri(Url.Action("Index", "Home"))
.Build();
// Logout from Auth0
await HttpContext.SignOutAsync(
Auth0Constants.AuthenticationScheme,
authenticationProperties
);
// Logout from the application
await HttpContext.SignOutAsync(
CookieAuthenticationDefaults.AuthenticationScheme
);
}
}
```
```json appsettings.json lines
{
"Auth0": {
"Domain": "dev-gja8kxz4ndtex3rq.us.auth0.com",
"ClientId": "mz9iNEIo2PHu7oeh8QRt19ndTyyCIgai"
}
}
```
Sign up for an{" "}
Auth0 account
{" "}
or{" "}
console.log("log in")}>
log in
{" "}
to your existing account to integrate directly with your own tenant.