Connect to PingOne Data in Airbyte ELT Pipelines
Airbyte empowers users to load your data into any data warehouse, data lake, or database. When combined with CData Connect AI, Airbyte users can create Extract, Load, Transform (ELT) pipelines directly from live PingOne data. This article illustrates the process of connecting to PingOne through Connect AI and constructing ELT pipelines for PingOne data within Airbyte.
CData Connect AI offers a dedicated SQL Server interface for PingOne, facilitating data querying without the need for data replication to a native database. With built-in optimized data processing capabilities, CData Connect AI efficiently directs all supported SQL operations, including filters and JOINs, straight to PingOne. This harnesses server-side processing to swiftly retrieve the desired PingOne data.
Configure PingOne Connectivity for Airbyte
Connectivity to PingOne from Airbyte is made possible through CData Connect AI. To work with PingOne data from Airbyte, we start by creating and configuring a PingOne connection.
- Log into Connect AI, click Sources, and then click Add Connection
- Select "PingOne" from the Add Connection panel
-
Enter the necessary authentication properties to connect to PingOne.
To connect to PingOne, configure these properties:
- Region: The region where the data for your PingOne organization is being hosted.
- AuthScheme: The type of authentication to use when connecting to PingOne.
- Either WorkerAppEnvironmentId (required when using the default PingOne domain) or AuthorizationServerURL, configured as described below.
Configuring WorkerAppEnvironmentId
WorkerAppEnvironmentId is the ID of the PingOne environment in which your Worker application resides. This parameter is used only when the environment is using the default PingOne domain (auth.pingone). It is configured after you have created the custom OAuth application you will use to authenticate to PingOne, as described in Creating a Custom OAuth Application in the Help documentation.
First, find the value for this property:
- From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
- Find the environment in which you have created your custom OAuth/Worker application (usually Administrators), and click Manage Environment. The environment's home page displays.
- In the environment's home page navigation sidebar, click Applications.
- Find your OAuth or Worker application details in the list.
-
Copy the value in the Environment ID field.
It should look similar to:
WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'
Now set WorkerAppEnvironmentId to the value of the Environment ID field.
Configuring AuthorizationServerURL
AuthorizationServerURL is the base URL of the PingOne authorization server for the environment where your application is located. This property is only used when you have set up a custom domain for the environment, as described in the PingOne platform API documentation. See Custom Domains.
Authenticating to PingOne with OAuth
PingOne supports both OAuth and OAuthClient authentication. In addition to performing the configuration steps described above, there are two more steps to complete to support OAuth or OAuthCliet authentication:
- Create and configure a custom OAuth application, as described in Creating a Custom OAuth Application in the Help documentation.
- To ensure that the driver can access the entities in Data Model, confirm that you have configured the correct roles for the admin user/worker application you will be using, as described in Administrator Roles in the Help documentation.
- Set the appropriate properties for the authscheme and authflow of your choice, as described in the following subsections.
OAuth (Authorization Code grant)
Set AuthScheme to OAuth.
Desktop Applications
Get and Refresh the OAuth Access Token
After setting the following, you are ready to connect:
- InitiateOAuth: GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the OAuthAccessToken each time you connect, use InitiateOAuth.
- OAuthClientId: The Client ID you obtained when you created your custom OAuth application.
- OAuthClientSecret: The Client Secret you obtained when you created your custom OAuth application.
- CallbackURL: The redirect URI you defined when you registered your custom OAuth application. For example: https://localhost:3333
When you connect, the driver opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:
- The driver obtains an access token from PingOne and uses it to request data.
- The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.
The driver refreshes the access token automatically when it expires.
For other OAuth methods, including Web Applications, Headless Machines, or Client Credentials Grant, refer to the Help documentation.
- Click Save & Test
-
Navigate to the Permissions tab in the Add PingOne Connection page and update the User-based permissions.
Add a Personal Access Token
When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.
- Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
- On the Settings page, go to the Access Tokens section and click Create PAT.
-
Give the PAT a name and click Create.
- The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.
With the connection configured and a PAT generated, you are ready to connect to PingOne data from Airbyte.
Connect to PingOne from Airbyte
To establish a connection from Airbyte to CData Connect AI, follow these steps.
- Log in to your Airbyte account
- On the left panel, click Sources, then Add New Source
- Set Source Type to MSSQL Server to connect the TDS endpoint
- Set Source Name
- Set Host URL to tds.cdata.com
- Set Port to 14333
- Set Database to the name of the connection you previously configured, e.g. PingOne1.
- Set Username to your Connect AI username
- Set SSL Method to Encrypted (trust server certificate), leave the Replication Method as standard, and set SSH Tunnel Method to No Tunnel
- (Optional) Set Schema to anything you want to apply to the source
- Set Password to your Connect AI PAT
- (Optional) Enter any needed JBDC URL Params
- Click Test and Save to create the data source.
Create ELT Pipelines for PingOne Data
To connect PingOne data with a new destination, click Sources and then Set Up Connection to connect to your destination. Select the source created above and your desired destination, then allow Airbyte to process. When it is done, your connection is ready for use.
Get CData Connect AI
To get live data access to 300+ SaaS, Big Data, and NoSQL sources directly from Airbyte, try CData Connect AI today!