package core
- Alphabetic
- Public
- All
Type Members
-
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
-
case class
AuthenticationException() extends Exception with Product with Serializable
An exception thrown when there is an error in the authentication flow
-
case class
AuthenticationMethod(method: String) extends Product with Serializable
A class representing an authentication method
-
sealed
trait
AuthenticationResult extends AnyRef
An object that represents the different results of the authentication flow
-
trait
Authorization[U] extends AnyRef
A trait to define Authorization objects that let you hook an authorization implementation in SecuredActions
-
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) extends GenericProfile with Product with Serializable
An implementation of the GenericProfile
- final case class EnableRefererAsOriginalUrl(value: Boolean) extends AnyVal with Product with Serializable
-
abstract
class
Event[U] extends AnyRef
A trait to model SecureSocial events
-
abstract
class
EventListener extends AnyRef
The event listener interface
-
trait
GenericProfile extends UserProfile
A generic profile
-
abstract
class
IdentityProvider extends AnyRef
Base class for all Identity Providers.
-
case class
LoginEvent[U](user: U) extends Event[U] with Product with Serializable
The event fired when a users logs in
-
case class
LogoutEvent[U](user: U) extends Event[U] with Product with Serializable
The event fired when a user logs out
-
trait
OAuth1Client extends AnyRef
A trait that allows mocking the OAuth 1 client
-
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
-
abstract
class
OAuth1Provider extends IdentityProvider
Base class for all OAuth1 providers
- case class OAuth1Settings(requestTokenUrl: String, accessTokenUrl: String, authorizationUrl: String, consumerKey: String, consumerSecret: String) extends Product with Serializable
- trait OAuth2Client extends AnyRef
-
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
-
abstract
class
OAuth2Provider extends IdentityProvider with ApiSupport
Base class for all OAuth2 providers
-
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.
-
case class
PasswordChangeEvent[U](user: U) extends Event[U] with Product with Serializable
The event fired when a user changes his password
-
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
-
case class
PasswordResetEvent[U](user: U) extends Event[U] with Product with Serializable
The event fired when a user completes a password reset
- final case class RegistrationEnabled(value: Boolean) extends AnyVal with Product with Serializable
-
trait
RuntimeEnvironment extends AnyRef
A runtime environment where the services needed are available
-
trait
SecureSocial extends ControllerHelpers with I18nSupport
Provides the actions that can be used to protect controllers and retrieve the current user if available.
- trait SecureSocialController extends BaseController with SecureSocial
-
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
- final case class SslEnabled(value: Boolean) extends AnyVal with Product with Serializable
-
trait
UserProfile extends AnyRef
A minimal user profile
Value Members
-
object
AuthenticationMethod extends Serializable
Authentication methods used by the identity providers
- object AuthenticationResult
- object EnableRefererAsOriginalUrl extends Serializable
- object Event
-
object
Events
Helper object to fire events
- object IdentityProvider
- object OAuth1Client
- object OAuth1Provider
- object OAuth1Settings extends Serializable
- object OAuth2Client
- object OAuth2Constants
- object OAuth2Settings extends Serializable
- object RegistrationEnabled extends Serializable
- object RuntimeEnvironment
- object SecureSocial
- object ServiceInfoHelper
- object SslEnabled extends Serializable
-
object
utils
Utility methods