provider

Type Members

1. class AccessDenied extends OAuthError

   

2. case class AccessToken(token: String, refreshToken: Option[String], scope: Option[String], lifeSeconds: Option[Long], createdAt: Date, params: Map[String, String] = Map.empty[String, String]) extends Product with Serializable

   

   Access token

   Access token

   token

   Access token is used to authentication.

   refreshToken

   Refresh token is used to re-issue access token.

   scope

   Inform the client of the scope of the access token issued.

   lifeSeconds

   Life of the access token since its creation. In seconds.

   createdAt

   Access token is created date.

   params

   Additional parameters to add information/restriction on given Access token.

3. trait AccessTokenFetcher extends AnyRef

   

4. case class AuthInfo[+U](user: U, clientId: Option[String], scope: Option[String], redirectUri: Option[String], codeChallenge: Option[String] = None, codeChallengeMethod: Option[CodeChallengeMethod] = None) extends Product with Serializable

   

   Authorized information

   Authorized information

   user

   Authorized user which is registered on system.

   clientId

   Using client id which is registered on system.

   scope

   Inform the client of the scope of the access token issued.

   redirectUri

   This value is used by Authorization Code Grant.

   codeChallenge

   This value is used by Authorization Code Grant for PKCE support.

   codeChallengeMethod

   This value is used by Authorization Code Grant for PKCE support.

5. class AuthorizationCode extends GrantHandler

   

6. case class AuthorizationCodeRequest(request: AuthorizationRequest) extends AuthorizationRequest with Product with Serializable

   

7. trait AuthorizationHandler[U] extends AnyRef

   

   Provide Authorization phases support for using OAuth 2.0.

   Provide Authorization phases support for using OAuth 2.0.

   [Authorization phases]

   Authorization Code Grant

   • validateClient(request)
   • findAuthInfoByCode(code)
   • deleteAuthCode(code)
   • getStoredAccessToken(authInfo)
   • refreshAccessToken(authInfo, token)
   • createAccessToken(authInfo)

   Refresh Token Grant

   • validateClient(clientCredential, grantType)
   • findAuthInfoByRefreshToken(refreshToken)
   • refreshAccessToken(authInfo, refreshToken)

   Resource Owner Password Credentials Grant

   • validateClient(request)
   • findUser(request)
   • getStoredAccessToken(authInfo)
   • refreshAccessToken(authInfo, token)
   • createAccessToken(authInfo)

   Client Credentials Grant

   • validateClient(request)
   • findUser(request)
   • getStoredAccessToken(authInfo)
   • refreshAccessToken(authInfo, token)
   • createAccessToken(authInfo)

   Implicit Grant

   • validateClient(request)
   • findUser(request)
   • getStoredAccessToken(authInfo)
   • createAccessToken(authInfo)

8. class AuthorizationRequest extends RequestBase

   

9. case class ClientCredential(clientId: String, clientSecret: Option[String]) extends Product with Serializable

   

10. class ClientCredentials extends GrantHandler

    

11. case class ClientCredentialsRequest(request: AuthorizationRequest) extends AuthorizationRequest with Product with Serializable

    

12. sealed trait CodeChallengeMethod extends AnyRef

    

13. trait DataHandler[U] extends AuthorizationHandler[U] with ProtectedResourceHandler[U]

    

    Provide accessing to data storage for using OAuth 2.0.

14. class ExpiredToken extends OAuthError

    

15. case class FetchResult(token: String, params: Map[String, String]) extends Product with Serializable

    

16. trait GrantHandler extends AnyRef

    

17. case class GrantHandlerResult[U](authInfo: AuthInfo[U], tokenType: String, accessToken: String, expiresIn: Option[Long], refreshToken: Option[String], scope: Option[String], params: Map[String, String]) extends Product with Serializable

    

18. class Implicit extends GrantHandler

    

19. case class ImplicitRequest(request: AuthorizationRequest) extends AuthorizationRequest with Product with Serializable

    

20. class InsufficientScope extends OAuthError

    

21. class InvalidClient extends OAuthError

    

22. class InvalidGrant extends OAuthError

    

23. class InvalidRequest extends OAuthError

    

24. class InvalidScope extends OAuthError

    

25. class InvalidToken extends OAuthError

    

26. abstract class OAuthError extends Exception

    

27. class Password extends GrantHandler

    

28. case class PasswordRequest(request: AuthorizationRequest) extends AuthorizationRequest with Product with Serializable

    

29. trait ProtectedResource extends AnyRef

    

30. trait ProtectedResourceHandler[+U] extends AnyRef

    

    Provide access to Protected Resource phase support for using OAuth 2.0.

    Provide access to Protected Resource phase support for using OAuth 2.0.

    [Access to Protected Resource phase]

    • findAccessToken(token)
    • findAuthInfoByAccessToken(token)

31. class ProtectedResourceRequest extends RequestBase

    

32. class RedirectUriMismatch extends OAuthError

    

33. class RefreshToken extends GrantHandler

    

34. case class RefreshTokenRequest(request: AuthorizationRequest) extends AuthorizationRequest with Product with Serializable

    

35. class RequestBase extends AnyRef

    

36. trait TokenEndpoint extends AnyRef

    

37. class UnauthorizedClient extends OAuthError

    

38. class UnsupportedGrantType extends OAuthError

    

39. class UnsupportedResponseType extends OAuthError