Nest Authbeta

Backend Reference

Full reference for `@ackplus/nest-auth`.

The NestJS module reference. Every page in this section maps to a piece of the public API.

  • NestAuthModuleforRoot() and forRootAsync() configuration.
  • Entities — every TypeORM entity, its fields, and its relations.
  • Decorators@Auth, @Public, @NestAuthRoles, @NestAuthPermissions, @SkipMfa, @CurrentTenantId, …
  • GuardsNestAuthAuthGuard, AdminSessionGuard.
  • ServicesAuthService, MfaService, UserService, RoleService, TenantService, SessionManagerService, JwtService, AccessKeyService, AuditService.
  • Hooks Reference — every config-time hook with execution-order timeline.
  • Events — every emitted event class and its payload.
  • Error Codes — every error code and its meaning.
  • Admin Console — the embedded dashboard.