Getting started

Follow steps below to install and use AuthEndpoints.

Create a project

Create a web api ASP.NET Core project

dotnet new webapi -n MyNewWebApp

Install nuget package

Install the library using the following .net cli command:

dotnet add package AuthEndpoints

or with nuget package manager:

Install-Package AuthEndpoints

Quick Start

First, let's create a DbContext:

// Data/MyDbContext.cs

using AuthEndpoints.Core.Models;
using Microsoft.EntityFrameworkCore;

namespace MyNewWebApp.Data;

public class MyDbContext : DbContext
{
  DbSet<IdentityUser>? Users { get; set; }
  DbSet<RefreshToken>? RefreshTokens { get; set; }

  public MyDbContext(DbContextOptions<MyDbContext> options) : base(options) { }
}

Configure database provider for MyDbContext and then add the required identity services:

// Program.cs

builder.Services.AddDbContext<MyDbContext>(options => 
{ 
  // Configure database provider for `MyDbContext`
});

builder.Services
  .AddIdentityCore<IdentityUser>() // <-- or `AddIdentity<,>`
  .AddEntityFrameworkStores<MyDbContext>() // <--
  .AddDefaultTokenProviders(); // <--

Next, let's add auth endpoints services:

// Program.cs

// Add users api endpoints
builder.Services
  .AddAuthEndpointsCore<IdentityUser, MyDbContext>() // <-- 
  .AddUsersApiEndpoints()
  .Add2FAEndpoints();

// Add JWT endpoints
builder.Services.AddSimpleJwtEndpoints<IdentityUser, MyDbContext>();

then finally, call app.MapEndpoints() before app.Run():

// Program.cs

...

var app = builder.Build();

...

app.UseAuthentication(); // <--
app.UseAuthorization(); // <--

...

app.MapEndpoints(); // <--

app.Run();

Run it and you should see endpoints available on swagger docs!

authendpoints swagger

Full Source Code

// Program.cs

using AuthEndpoints.Core;
using AuthEndpoints.MinimalApi;
using AuthEndpoints.SimpleJwt;
using Microsoft.AspNetCore.Identity;
using MyNewWebApp.Data;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
// Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();

builder.Services.AddDbContext<MyDbContext>(options => 
{ 
  // Configure database provider for `MyDbContext` here
  // ...
});

builder.Services
  .AddIdentityCore<IdentityUser>() // <--
  .AddEntityFrameworkStores<MyDbContext>() // <-- Microsoft.AspNetCore.Identity.EntityFrameworkCore
  .AddDefaultTokenProviders(); // <--

// Add basic authentication
builder.Services
  .AddAuthEndpointsCore<IdentityUser>() // <-- 
  .AddUsersApiEndpoints()
  .Add2FAEndpoints();

// Add JWT endpoints
builder.Services.AddSimpleJwtEndpoints<IdentityUser, MyDbContext>();

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
  app.UseSwagger();
  app.UseSwaggerUI();
}

app.UseHttpsRedirection();

app.UseAuthentication(); // <--
app.UseAuthorization(); // <--

app.MapControllers();

app.MapEndpoints(); // <-- Map minimal api endpoints

app.Run();

Available Endpoints

Checkout endpoints definition docs