Rest Source OAuth2

Parent Previous Next


Rest Source OAuth2 Connection Manager


Used with the Rest Source data flow component.


Important Note

Users will need to first register a new app with the service being used in order to obtain Api Keys and Secrets. This can be done by visiting the service's developer website. For more information about creating and using OAuth2 connections, please see this online article as well as this diagram.


Rest Source OAuth2 connection manager is available for SQL versions 2012 and higher.



 Configuration File - Users can create and use a configuration file to help setup the OAuth2 connection. Click here for more information about using Configuration Files.

 Api Key and API Secret - Authentication information provided to users at the application's developer site.

 Access Token - To obtain this information if you do not already have it, click the Get Token button and complete the information requested in the Token Getter user interface.

 Is Bearer Token - Select this option if the Access Token is a bearer token.

 Access Token Expiration Date - The expiration date of the access token.


Token Getter (opened when Get Token button is used.)



 Choose Settings File - Users can select pre-configured settings for several popular services including, but not limited to: Google,  GoToMeeting, and Paypal Sandbox.

 Client / Api Key - Authentication information provided to users at the application's developer site. (This should match the Api Key from the Connection Settings window.)

 Client / Api Secret - Authentication information provided to users at the application's developer site. (This should match the Api Key from the Connection Settings window.)

 Authorization Request Url - The url used to request authorization from the service (Example:https://api.citrixonline.com/oauth/authorize?client_id={ApiKey})

 Grant / Response Code Parameter - The parameter name used to store the value within the Access Token Request Url Query String

 Access Token Request Url - The url used to request an access token from the service. (Example: https://api.citrixonline.com/oauth/access_token)

 Get / Post Selectbox - Determines whether the call is a Get or Post action.

 Access Token Request Url Query String - The query that will be appended to the end of the Access Token Request Url. This query contains all of the required parameters needed to be passed to the service to retrieve the access token.

 Get Token - Clicking this button will open the (configured) service's online authentication screen in the window below. To complete the process, enter the credentials of the account used to access the service. If successful, the Token Getter window will close and the user will return to the Connection Settings window. (Note: bad requests should redirect to a url configured either in the application or the access token request url. Users can also copy the url to help troubleshoot invalid requests.)


Please see your service's online documentation to assist in retrieving the above information.


Headers

Users can create header names and values by entering the information in their corresponding windows.



Refresh Token (Results Returned In Json)



 Refresh Token - Authentication information provided to users at the application's developer site. (This should match the Api Key from the Connection Settings window.)

 Refresh Token Request Url - Identifies the Url the token uses.

 Results Returned In - Specify how results are returned from the application (Json, XML, or String.)

 Access Token Path - Identifies the token path

 Headers - Allows users to add headers within the refresh token.


Refresh Token (Results Returned In String)



 Refresh Token - Authentication information provided to users at the application's developer site. (This should match the Api Key from the Connection Settings window.)

 Refresh Token Request Url - Identifies the Url the token uses.

 Results Returned In - Specify how results are returned from the application (Json or XML.)

 Access Token Path - Users will use this box when adding a regular expression to parse the returned data.

 Group Index - Identifies the index position to return (0 based).

 Headers - Allows users to add headers within the refresh token.


Proxy



 Proxy Host - When connecting to an endpoint using a proxy, users should enter the proxy Url in this field.

 Proxy Port - The port number that corresponds to the Url proxy host

 User Name - The username needed to authenticate to the proxy.

 Password - The password that allows the user to authenticate to the proxy.