Class used to create instances of OAuthProvider
.
Public Method Summary
OAuthProvider.Builder |
addCustomParameter(String paramKey,
String
paramValue)
Configures custom parameters to be passed to the identity provider during the
OAuth sign-in flow.
|
OAuthProvider.Builder |
addCustomParameters(Map<String, String>
customParameters)
Similar to
addCustomParameter(String, String) , this takes a Map and adds each
entry to the set of custom parameters to be passed.
|
OAuthProvider |
build()
Returns an
OAuthProvider
created from this OAuthProvider.Builder .
|
OAuthProvider.Builder |
Inherited Method Summary
Public Methods
public OAuthProvider.Builder addCustomParameter (String paramKey, String paramValue)
Configures custom parameters to be passed to the identity provider during the OAuth sign-in flow. Calling this method multiple times will add to the set of custom parameters being passed, rather than overwriting them (as long as key values don't collide).
Parameters
paramKey | the name of the custom parameter |
---|---|
paramValue | the value of the custom parameter |
public OAuthProvider.Builder addCustomParameters (Map<String, String> customParameters)
Similar to
addCustomParameter(String, String)
, this takes a Map and adds each entry to
the set of custom parameters to be passed. Calling this method multiple times will add
to the set of custom parameters being passed, rather than overwriting them (as long as
key values don't collide).
Parameters
customParameters | a dictionary of custom parameter names and values to be passed to the identity provider as part of the sign-in flow. |
---|
public OAuthProvider build ()
Returns an OAuthProvider
created from this OAuthProvider.Builder
.
public OAuthProvider.Builder setScopes (List<String> scopes)
Sets the OAuth 2 scopes to be presented to the user during their sign-in flow with the identity provider.