Integrate with Live PingOne Data in MuleSoft (via CData Connect AI)
The MuleSoft Anypoint Platform enables the building, deployment, and management of APIs and integrations, facilitating seamless connectivity across applications and systems. When combined with CData Connect AI, it provides access to PingOne data for visualizations, dashboards, and more. This article explains how to use CData Connect AI to create a live connection to PingOne and how to connect and access live PingOne data from the MuleSoft Anypoint Platform.
Prerequisites
Before configuring and using MuleSoft with CData Connect AI, you must first connect a data source to your CData Connect AI account. For more information, see the Connections section.
Additionally, you need to generate a Personal Access Token (PAT) on the Settings page. Be sure to copy it down, as it serves as your password during authentication.
Configure PingOne Connectivity for MuleSoft
Connectivity to PingOne from MuleSoft is made possible through CData Connect AI. To work with PingOne data from MuleSoft, 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 Mulesoft.
Connecting to CData Connect AI
Follow these steps to establish a connection from Mulesoft to CData Connect AI through the JDBC driver:
-
Download and install the CData Connect AI JDBC driver.
- Open the Integrations page of CData Connect AI.
- Search for and select JDBC.
- Download and run the setup file.
- When the installation is complete, the JAR file can be found in the installation directory (inside the lib folder).
- Log into Mulesoft Anypoint Studio or launch the desktop application.
- Create a new Mulesoft project.
The new project appears in a project folder.
- In the Mule Palette located on the right, drag an HTTP Listener to the Message Flow area.
- Click on the HTTP Listener to configure it.
- Click the + sign on the right of Connector configuration. The HTTP Listener config dialog appears.
- Configure the HTTP Listener, providing a Port on which to query your data, and click OK.
- Provide a path on which to perform the actions. The HTTP Listener is now configured.
- In the Mule Palette on the right, type database in the search bar.
- Drag the database operation you want to perform to the Message Flow area. For this example, we choose Select.
- Select Generic Connection from the Connection dropdown in the Database Config dialog.
- Click the Configure button to configure the JDBC driver. Select Use local file from the drop-down list.
- Locate the CData Connect AI JAR file from the JDBC driver installation and click OK.
- Provide the following information:
- URL: the URL for the connection, for example:
Note: the password is the PAT created in the Prerequisites section.jdbc:connect:Authscheme=Basic;user=username;password=PAT - Driver class name: Enter the Driver class name as:
cdata.jdbc.connect.ConnectDriver
- URL: the URL for the connection, for example:
- Click Test Connection.
- If the connection is successful, provide the SQL Query Text in the editor. You can see the table metadata on the right side in the Output tab.
- In the Mule Palette, drag Transform Message to the Message Flow area.
- Click Transform Message to configure it. Change the Output as follows:
- Save your project and run it. In the console, Mulesoft starts initializing the dependencies.
- Once you see the message, "Message source 'listener' on flow your_project_name successfully started", you can start querying your data at the endpoint you provided.
- Query to check out the data using the Postman application (as shown below).
SQL Access to PingOne Data from Cloud Applications
Now you have a direct connection to live PingOne data from MuleSoft Anypoint Platform. You can create more connections to ensure seamless data flow, automate business processes, and manage APIs - all without replicating PingOne data.
To get real-time data access to hundreds of SaaS, Big Data, and NoSQL sources (including PingOne) directly from your cloud applications, explore the CData Connect AI.