Interface AuthenticationPlugin

Plugin used in the UserAdminService to login/logout a user. The UserAdminService is only available if at least on AuthenticationPlugin is available in the system. An AuthenticationPlugin must be registered as service with interface system.user.api.AuthenticationPlugin.

interface AuthenticationPlugin {
    getAuthorization(user, userAdmin): Authorization;
    getUser(authentication, userAdmin): undefined | User;
    login(credentials, userAdmin): Authentication | Promise<Authentication>;
    logout(authentication, userAdmin): boolean | Promise<boolean>;
}

Index

Methods

getAuthorization getUser login logout

Methods

getAuthorization

getAuthorization(user, userAdmin): Authorization
Get authorization data for a user.
Parameters
- user: undefined | User
- userAdmin: UserAdminService
Returns Authorization
authorization instance
- Defined in apprt/api/index.ts:2262

getUser

getUser(authentication, userAdmin): undefined | User
Get user associated with an authentication.
Parameters
- authentication: Authentication
- userAdmin: UserAdminService
Returns undefined | User
user instance
- Defined in apprt/api/index.ts:2268

login

login(credentials, userAdmin): Authentication | Promise<Authentication>
Login a user.
Parameters
- credentials: undefined | LoginCredentials
- userAdmin: UserAdminService
Returns Authentication | Promise<Authentication>
authentication instance
- Defined in apprt/api/index.ts:2246

logout

logout(authentication, userAdmin): boolean | Promise<boolean>
Logout a user.
Parameters
- authentication: Authentication
- userAdmin: UserAdminService
Returns boolean | Promise<boolean>
success state
- Defined in apprt/api/index.ts:2256

Generated using TypeDoc