Admin login service
Overview
Service class to provide API methods related to CMS admin login and user sessions. See CMS permissioning for a full guide to CMS admin users.
| Full path | preside.system.services.admin.LoginService |
|---|---|
| Wirebox ref | LoginService |
| Singleton | Yes |
Public API Methods
- attemptTwoFactorAuthentication()
- createLoginResetToken()
- disableTwoFactorAuthenticationForUser()
- enableTwoFactorAuthenticationForUser()
- generateTwoFactorAuthenticationKey()
- getLoggedInUserDetails()
- getLoggedInUserId()
- getOrCreateUser()
- getTwoFactorAuthenticationKey()
- isLoggedIn()
- isPasswordCorrect()
- isSystemUser()
- isTwoFactorAuthenticated()
- isTwoFactorAuthenticationEnabled()
- isTwoFactorAuthenticationEnabledForUser()
- isTwoFactorAuthenticationSetupForUser()
- login()
- logout()
- recordLogin()
- recordLogout()
- recordVisit()
- resendPasswordResetInstructions()
- resetPassword()
- sendPasswordResetInstructions()
- sendWelcomeEmail()
- twoFactorAuthenticationRequired()
- validateResetPasswordToken()