Identity.Module.API 2.0.122

.NET Modular Dynamic Identity Manager

Modular dynamic identity manager for users, roles, claims and more for access control in Asp.Net Mvc Core and Web API, using .NET 8 Minimal API, Entity Framework Core and SQL Server.

📎 Table of Contents

• Table of Contents
• Features
• Installation
• Configuration
• Usage Example
• API Reference
• ToDo
• Packages
• Badges
• License
• Give a Star
• Contributing
• Support

🧩 Features

• Minimal API: Built using .NET 8 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 and policies.
• Flexible Configuration: Easily configurable via appsettings.json to suit your application's needs.

🛠️ Installation

Prerequisites

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

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:

{
    "JwtOptions": {
        "Issuer": "[ISSUER]",
        "Audience": "[AUDIENCE]",
        "SecurityKey": "[SECURITY-KEY-512-CHAR]",
        "AccessTokenExpirationMinutes": 60,
        "RefreshTokenExpirationMinutes": 60,
        "RequireUniqueEmail": true,
        "RequireDigit": true,
        "RequiredLength": 8,
        "RequireUppercase": true,
        "RequireLowercase": true,
        "RequireNonAlphanumeric": true,
        "RequiredUniqueChars": 4,
        "RequireConfirmedEmail": true,
        "MaxFailedAccessAttempts": 3,
        "AllowedForNewUsers": true,
        "DefaultLockoutTimeSpan": "00:05:00"
    },
    "SmtpOptions": {
        "Host": "smtp.example.org",
        "Port": 25,
        "Security": "StartTls",
        "Username": "Username del server SMTP",
        "Password": "Password del server SMTP",
        "Sender": "MyApplication <noreply@example.org>",
        "SaveEmailSent": true
    },
    "UsersOptions": {
        "AssignAdminRoleOnRegistration": "admin@example.org",
        "PasswordExpirationDays": 90
    },
    "ValidationOptions": {
        "MinLength": 3,
        "MaxLength": 50,
        "MinLengthDescription": 5,
        "MaxLengthDescription": 100
    },
    "HostedServiceOptions": {
        "IntervalAuthPolicyUpdaterMinutes": 5
    },
    "ApplicationOptions": {
        "MigrationsAssembly": "MinimalApi.Identity.Migrations" //Default for migrations assembly is the project that contains the Program.cs class
    },
    "ConnectionStrings": {
        "DatabaseType": "sqlserver",
        "SQLServer": "Data Source=[HOSTNAME];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD];Encrypt=False"
    }
}

💡 Usage Examples

A practical example of Program.cs configuration is available here

📚 API Reference

See the documentation for a list of all available endpoints.

🏗️ ToDo

• Move the configuration of the claims to a dedicated library
• Move the configuration of the module to a dedicated library
• Move the configuration of the profile manager to a dedicated library
• Move the configuration of the roles to a dedicated library
• Add CancellationToken to API endpoints (where necessary)
• Move email sending logic (with improvements) to a hosted service
• Add email sending implementation to AccountQuery class
• Add automatic creation of a default administrator account
• Replacing exceptions with implementation of operation results
• Replacing the hosted service email sender using Coravel jobs
• Replacing the hosted service authorization policy updater using Coravel jobs
• Add support for relational databases other than MS SQLServer (e.g. MySQL and PostgreSQL)
• Add endpoints for two-factor authentication and management
• Add endpoints for downloading and deleting personal data
• Add support for multi tenancy
• Add authentication support from third-party providers (e.g. GitHub, Azure)

📦 Packages

Main packages:

Package Name	Version	Downloads
Identity.Module.API

Optional packages:

Package Name	Version	Downloads
Identity.Module.Licenses

Dependencies Packages:

Package Name	Version	Downloads
Identity.Module.AccountManager	Coming soon
Identity.Module.ClaimsManager	Coming soon
Identity.Module.Core
Identity.Module.EmailManager	Coming soon
Identity.Module.ModuleManager	Coming soon
Identity.Module.PolicyManager
Identity.Module.ProfileManager	Coming soon
Identity.Module.RolesManager	Coming soon

🏆 Badges

📜 License

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

⭐ Give a Star

Don't forget that if you find this project useful, put 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, you can add a new thread here.