API Reference

Components

This plugin exposes the following components (opens new window) in context of your application:

Controllers

The following controlllers (opens new window) are provided for implementing some default endpoints:

• User

Policies

Several policies (opens new window) are available for customizing authentication and authorization support in your application:

• Authentication
• Authorization
• User

Models

These models (opens new window) are provided to manage access control at runtime:

• User
• Role
• UserToRole
• AuthorizationRule

Services

Commonly useful services (opens new window) regarding authentication and authorization are:

• AuthenticationPassport
• AuthenticationStrategies
• AuthManager
• AuthorizationNode
• AuthorizationTree
• AuthorizationPolicyGenerator

Configuration

In addition to components listed above the plugin is processing some optionally available runtime configuration.

Routing defaults

Unless disabled in runtime configuration, this plugin is always setting up routes providing basic user authentication to a client.