Access PingOne Data in Mule Applications Using the CData JDBC Driver

The CData JDBC Driver for PingOne connects PingOne data to Mule applications enabling read functionality with familiar SQL queries. The JDBC Driver allows users to easily create Mule applications to backup, transform, report, and analyze PingOne data.

This article demonstrates how to use the CData JDBC Driver for PingOne inside of a Mule project to create a Web interface for PingOne data. The application created allows you to request PingOne data using an HTTP request and have the results returned as JSON. The exact same procedure outlined below can be used with any CData JDBC Driver to create a Web interface for the hundreds of available data sources.

1. Create a new Mule Project in Anypoint Studio.
2. Add an HTTP Connector to the Message Flow.
3. Configure the address for the HTTP Connector. 👁 Add and Configure the HTTP Connector
   
4. Add a Database Select Connector to the same flow, after the HTTP Connector.
5. Create a new Connection (or edit an existing one) and configure the properties.
   • Set Connection to "Generic Connection"
   • Select the CData JDBC Driver JAR file in the Required Libraries section (e.g. cdata.jdbc.pingone.jar). 👁 Adding the JAR file (Salesforce is shown).
     
   • Set the URL to the connection string for PingOne

     To connect to PingOne, configure these properties:

     • : The region where the data for your PingOne organization is being hosted.
     • : The type of authentication to use when connecting to PingOne.
     • Either (required when using the default PingOne domain) or , configured as described below.

     Configuring 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:

     1. From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
     2. 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.
     3. In the environment's home page navigation sidebar, click Applications.
     4. Find your OAuth or Worker application details in the list.
     5. Copy the value in the Environment ID field. It should look similar to:
        

        WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

     Now set to the value of the Environment ID field.

     Configuring 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 to OAuth.

     Desktop Applications

     Get and Refresh the OAuth Access Token

     After setting the following, you are ready to connect:

     • : GETANDREFRESH. To avoid the need to repeat the OAuth exchange and manually setting the each time you connect, use .
     • : The Client ID you obtained when you created your custom OAuth application.
     • : The Client Secret you obtained when you created your custom OAuth application.
     • : 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:

     1. The driver obtains an access token from PingOne and uses it to request data.
     2. The OAuth values are saved in the location specified in , 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.

     Built-in Connection String Designer

     For assistance in constructing the JDBC URL, use the connection string designer built into the PingOne JDBC Driver. Either double-click the JAR file or execute the jar file from the command-line.

     		java -jar cdata.jdbc.pingone.jar
     		

     Fill in the connection properties and copy the connection string to the clipboard.

   • Set the Driver class name to cdata.jdbc.pingone.PingOneDriver. 👁 A configured Database Connection (Salesforce is shown).
     
   • Click Test Connection.
6. Set the SQL Query Text to a SQL query to request PingOne data. For example:

   SELECT Id, Username FROM [CData].[Administrators].Users WHERE EmployeeType = 'Contractor'

   👁 Configure the Select object (Salesforce is Shown)
   
7. Add a Transform Message Component to the flow.
8. Set the Output script to the following to convert the payload to JSON:

   %dw 2.0
   output application/json
   ---
   payload
    

   👁 Add the Transform Message Component to the Flow
   
9. To view your PingOne data, navigate to the address you configured for the HTTP Connector (localhost:8081 by default): http://localhost:8081. The PingOne data is available as JSON in your Web browser and any other tools capable of consuming JSON endpoints.

At this point, you have a simple Web interface for working with PingOne data (as JSON data) in custom apps and a wide variety of BI, reporting, and ETL tools. Download a free, 30 day trial of the JDBC Driver for PingOne and see the CData difference in your Mule Applications today.