Packages

case class OAuth2Settings(authorizationURL: Option[String] = None, accessTokenURL: String, redirectURL: Option[String] = None, apiURL: Option[String] = None, clientID: String, clientSecret: String, scope: Option[String] = None, authorizationParams: Map[String, String] = Map.empty, accessTokenParams: Map[String, String] = Map.empty, customProperties: Map[String, String] = Map.empty) extends Product with Serializable

The OAuth2 settings.

authorizationURL

The authorization URL provided by the OAuth provider.

accessTokenURL

The access token URL provided by the OAuth provider.

redirectURL

The redirect URL to the application after a successful authentication on the OAuth provider. The URL can be a relative path which will be resolved against the current request's host.

apiURL

The URL to fetch the profile from the API. Can be used to override the default URL hardcoded in every provider implementation.

clientID

The client ID provided by the OAuth provider.

clientSecret

The client secret provided by the OAuth provider.

scope

The OAuth2 scope parameter provided by the OAuth provider.

authorizationParams

Additional params to add to the authorization request.

accessTokenParams

Additional params to add to the access token request.

customProperties

A map of custom properties for the different providers.

Linear Supertypes
Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. OAuth2Settings
  2. Serializable
  3. Product
  4. Equals
  5. AnyRef
  6. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new OAuth2Settings(authorizationURL: Option[String] = None, accessTokenURL: String, redirectURL: Option[String] = None, apiURL: Option[String] = None, clientID: String, clientSecret: String, scope: Option[String] = None, authorizationParams: Map[String, String] = Map.empty, accessTokenParams: Map[String, String] = Map.empty, customProperties: Map[String, String] = Map.empty)

    authorizationURL

    The authorization URL provided by the OAuth provider.

    accessTokenURL

    The access token URL provided by the OAuth provider.

    redirectURL

    The redirect URL to the application after a successful authentication on the OAuth provider. The URL can be a relative path which will be resolved against the current request's host.

    apiURL

    The URL to fetch the profile from the API. Can be used to override the default URL hardcoded in every provider implementation.

    clientID

    The client ID provided by the OAuth provider.

    clientSecret

    The client secret provided by the OAuth provider.

    scope

    The OAuth2 scope parameter provided by the OAuth provider.

    authorizationParams

    Additional params to add to the authorization request.

    accessTokenParams

    Additional params to add to the access token request.

    customProperties

    A map of custom properties for the different providers.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. val accessTokenParams: Map[String, String]
  5. val accessTokenURL: String
  6. val apiURL: Option[String]
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val authorizationParams: Map[String, String]
  9. val authorizationURL: Option[String]
  10. val clientID: String
  11. val clientSecret: String
  12. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  13. val customProperties: Map[String, String]
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  20. def productElementNames: Iterator[String]
    Definition Classes
    Product
  21. val redirectURL: Option[String]
  22. val scope: Option[String]
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped