👁 Image
Identity.Module.API 2.5.458

.NET Modular Dynamic Identity Manager

A set of libraries to easily integrate and extend authentication in ASP.NET Core projects, using ASP.NET Core Identity.

🏷️ Introduction

MinimalApi.Identity is a dynamic and modular identity manager for managing users, roles, claims and more for access control in Asp.Net Mvc Core and Web API, using .NET Minimal API, Entity Framework Core and relational database (of your choice).

🧩 Features

• Minimal API: Built using .NET 9 Minimal API for a lightweight and efficient implementation.
• Entity Framework Core: Uses EF Core for data access, making it easy to integrate with your existing database.
• Modular: The library is designed to be modular, allowing you to add or remove features as needed.
• Dynamic: Supports dynamic management of users, roles, claims, forms, licensing and policies.
• Flexible Configuration: Easily configurable via appsettings.json to suit your application's needs.
• Outbox Pattern: Implement the transactional outbox pattern for reliable email sending.

🛠️ Installation

Prerequisites

• .NET 9.0 SDK (latest version)
• SQL Server 2022 Express installed (setup for Windows) or in Docker version (example)

As an alternative to SQL Server you can use one of these databases:

• Azure SQL Database (setup guide)
• PostgreSQL - Docker version (example)
• MySQL - Docker version (example)
• SQLite

Setup

The library is available on NuGet, just search for Identity.Module.API in the Package Manager GUI or run the following command in the .NET CLI:

dotnet add package Identity.Module.API

⚙️ Configuration

The configuration can be completely managed by adding this section to the appsettings.json file:

A complete example of the configurations in AppSettings.json is available here.

🗃️ Database

Configuration

The library uses Entity Framework Core to manage the database.

The connection string is configured in the AppSettings section of the appsettings.json file, while the database type is configured in the Program.cs class.

After configuring the Program.cs class, modify the connection string for the corresponding database.

Migrations

To create database migrations select MinimalApi.Identity.Core as the default project from the drop-down menu in the Package Manager Console and run the command: Add-Migration MIGRATION-NAME

Example: Add-Migration InitialMigration -Project MinimalApi.Identity.Migrations.SQLServer

📎 Swagger / OpenAPI

It is possible to protect access to the Swagger UI with the following configuration in SwaggerSettings:

• RequiredAuth: set via AuthSettings:IsRequired (supported values: true, false)
• Username: set via AuthSettings:Username
• Password: set via AuthSettings:Password

You can manage the state of the Swagger UI with the following configuration:

• Enable/Disable Swagger UI: set via SwaggerSettings:IsEnabled (supported values: true, false)

💡 Usage Examples

A complete example of the Program.cs class is available here.

🔐 Authentication

The following authentication types are currently supported:

• JWT Bearer Token

🧑‍💼 Administrator Account

A default administrator account is created automatically with the following configuration:

• Email: set via AppSettings:AssignAdminEmail
• Username: set via AppSettings:AssignAdminUsername
• Password: set via AppSettings:AssignAdminPassword

🏆 Badges

👁 Quality Gate Status
👁 Bugs
👁 Code Smells
👁 Duplicated Lines (%)
👁 Lines of Code

👁 Reliability Rating
👁 Security Rating
👁 Technical Debt
👁 Maintainability Rating
👁 Vulnerabilities

👁 SonarCloud

🗺️ Roadmap

In this solution no further development activities are currently planned.

In the .NET 10 solution (in a dedicated, temporarily private repository):

• Migrate solution to .NET 10 (⌛ in progress)
• Replacing the hosted service email sender using Coravel jobs
• Add support for multi tenancy
• Align endpoints with the updated version of ASP.NET Core Identity (including endpoints for two-factor authentication and management, downloading and deleting personal data)
• Add authentication support from third-party providers Auth0
• Add authentication support from third-party providers KeyCloak
• Add authentication support from third-party providers GitHub
• Add authentication support from third-party providers Azure
• Code Review and Refactoring
• Update documentation

📜 License

This project is licensed under the MIT License - see the file for details.

⭐ Give a Star

Don't forget that if you find this project helpful, please give it a ⭐ on GitHub to show your support and help others discover it.

🤝 Contributing

The project is constantly evolving. Contributions are always welcome. Feel free to report issues and submit pull requests to the repository, following the steps below:

1. Fork the repository
2. Create a feature branch (starting from the develop branch)
3. Make your changes
4. Submit a pull requests (targeting develop)

🆘 Support

If you have any questions or need help, read here to find out what to do.