Identity.Module.API 2.5.9

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

📎 Table of Contents

• Features
• Installation
• Configuration
• Usage Example
• API Reference
• 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, 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 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:

{
    "ConnectionStrings": {
        "DatabaseType": "sqlserver",
        "SQLServer": "Data Source=[HOSTNAME];Initial Catalog=[DATABASE];User ID=[USERNAME];Password=[PASSWORD];Encrypt=False"
    },
    "JwtOptions": {
        "SchemaName": "Bearer",
        "Issuer": "[ISSUER]",
        "Audience": "[AUDIENCE]",
        "SecurityKey": "[SECURITY-KEY-512-CHAR]",
        "ClockSkew": "00:05:00",
        "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
    },
    "ApplicationOptions": {
        "MigrationsAssembly": "MinimalApi.Identity.Migrations",
        "ErrorResponseFormat": "List"
    },
    "FeatureFlagsOptions": {
        "EnabledFeatureLicense": true,
        "EnabledFeatureModule": true
    },
    "HostedServiceOptions": {
        "IntervalAuthPolicyUpdaterMinutes": 5
    },
    "UsersOptions": {
        "AssignAdminRoleOnRegistration": "admin@example.org",
        "PasswordExpirationDays": 90
    },
    "ValidationOptions": {
        "MinLength": 3,
        "MaxLength": 50,
        "MinLengthDescription": 5,
        "MaxLengthDescription": 100
    }
}

🗃️ Database

See the documentation for managing the database

💡 Usage Examples

A practical example of Program.cs configuration is available here

🔐 Authentication

This library currently supports the following authentication types:

• JWT Bearer Token

📚 API Reference

See the documentation for a list of all available endpoints.

📦 Packages

See the documentation for a list of all available packages.

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