core

Type Members

1. trait ApiSupport extends AnyRef

   

   This traits enables providers to be used by the LoginApi controller.

   This traits enables providers to be used by the LoginApi controller.

   See also

   LoginApi

2. case class AuthenticationException() extends Exception with Product with Serializable

   

   An exception thrown when there is an error in the authentication flow

3. case class AuthenticationMethod(method: String) extends Product with Serializable

   

   A class representing an authentication method

4. sealed trait AuthenticationResult extends AnyRef

   

   An object that represents the different results of the authentication flow

5. trait Authorization[U] extends AnyRef

   

   A trait to define Authorization objects that let you hook an authorization implementation in SecuredActions

6. case class BasicProfile(providerId: String, userId: String, firstName: Option[String], lastName: Option[String], fullName: Option[String], email: Option[String], avatarUrl: Option[String], authMethod: AuthenticationMethod, oAuth1Info: Option[OAuth1Info] = None, oAuth2Info: Option[OAuth2Info] = None, passwordInfo: Option[PasswordInfo] = None, extraInfo: Option[Map[String, String]] = None) extends GenericProfile with Product with Serializable

   

   An implementation of the GenericProfile

7. sealed trait Event[U] extends AnyRef

   

   A trait to model SecureSocial events

8. abstract class EventListener[U] extends Controller

   

   The event listener interface

9. trait GenericProfile extends UserProfile

   

   A generic profile

10. abstract class IdentityProvider extends AnyRef

    

    Base class for all Identity Providers.

11. case class LoginEvent[U](user: U) extends Event[U] with Product with Serializable

    

    The event fired when a users logs in

    The event fired when a users logs in

    user

12. case class LogoutEvent[U](user: U) extends Event[U] with Product with Serializable

    

    The event fired when a user logs out

    The event fired when a user logs out

    user

13. trait OAuth1Client extends AnyRef

    

    A trait that allows mocking the OAuth 1 client

14. case class OAuth1Info(token: String, secret: String) extends Product with Serializable

    

    The OAuth 1 details

    The OAuth 1 details

    token

    the token

    secret

    the secret

15. abstract class OAuth1Provider extends IdentityProvider

    

    Base class for all OAuth1 providers

16. trait OAuth2Client extends AnyRef

    

17. case class OAuth2Info(accessToken: String, tokenType: Option[String] = None, expiresIn: Option[Int] = None, refreshToken: Option[String] = None) extends Product with Serializable

    

    The Oauth2 details

    The Oauth2 details

    accessToken

    the access token

    tokenType

    the token type

    expiresIn

    the number of seconds before the token expires

    refreshToken

    the refresh token

18. abstract class OAuth2Provider extends IdentityProvider with ApiSupport

    

    Base class for all OAuth2 providers

19. case class OAuth2Settings(authorizationUrl: String, accessTokenUrl: String, clientId: String, clientSecret: String, scope: Option[String], authorizationUrlParams: Map[String, String], accessTokenUrlParams: Map[String, String]) extends Product with Serializable

    

    The settings for OAuth2 providers.

20. case class PasswordChangeEvent[U](user: U) extends Event[U] with Product with Serializable

    

    The event fired when a user changes his password

    The event fired when a user changes his password

    user

21. case class PasswordInfo(hasher: String, password: String, salt: Option[String] = None) extends Product with Serializable

    

    The password details

    The password details

    hasher

    the id of the hasher used to hash this password

    password

    the hashed password

    salt

    the optional salt used when hashing

22. case class PasswordResetEvent[U](user: U) extends Event[U] with Product with Serializable

    

    The event fired when a user completes a password reset

    The event fired when a user completes a password reset

    user

23. trait RuntimeEnvironment[U] extends AnyRef

    

    A runtime environment where the services needed are available

24. trait SecureSocial[U] extends Controller

    

    Provides the actions that can be used to protect controllers and retrieve the current user if available.

25. case class SignUpEvent[U](user: U) extends Event[U] with Product with Serializable

    

    The event fired when a user sings up with the Username and Password Provider

    The event fired when a user sings up with the Username and Password Provider

    user

26. trait UserProfile extends AnyRef

    

    A minimal user profile