Pipelet FinalizeOAuthLogin
This pipelet works in tandem with the InitiateOAuthLogin pipelet. After the user has been redirected by the InitiateOAuthLogin pipelet to the external OAuth2 compliant provider and the user has interacted with the provider's site, the browser is redirected to a URL configured on the provider's web site. This URL should be that of a pipeline that contains the FinalizeOAuthLogin pipelet. At this point the user has either been authenticated by the external provider or not (forgot password, or simply refused to provide credentials). If the user has been authenticated by the external provider and the provider returns an authentication code, this pipelet exchanges the code for a token and with that token it requests from the provider the user information specified by the configured scope (id, first/last name, email, etc.).
Group:
Customer
Flags:
Error Connector
Output Parameters
ResponseText
:
String
:
(Required)
The plain text of the response from the provider containing the user information. Usually in JSON or XML format.
AccessToken
:
String
:
(Optional)
The Access Token obtained from the OAuth provider
RefreshToken
:
String
:
(Optional)
The Refresh Token if returned by the OAuth provider
AccessTokenExpiry
:
Long
:
(Optional)
If the OAuth Provider returns this parameter - means for how many seconds the AccessToken is valid (typically at least 3600 secs).
OAuthProviderID
:
String
:
(Required)
The OAuth provider ID
ErrorStatus
:
String
:
(Optional)
Error Status - populated if there is an error inside the pipelet. Different than the 'error' code that may be returned from the provider.