How to connect to PingOne Data in DBVisualizer



Integrate PingOne data with visual data analysis tools and data connection wizards in DBVisualizer

The CData JDBC Driver for PingOne implements JDBC standards to provide connectivity to PingOne data in applications ranging from business intelligence tools to IDEs. This article shows how to establish a connection to PingOne data in DBVisualizer and use the table editor to load PingOne data.

Create a New Driver Definition for PingOne Data

Follow the steps below to use the Driver Manager to provide connectivity to PingOne data from DBVisualizer tools.

  1. In DBVisualizer, click Tools -> Driver Manager.
  2. Click the plus sign "" to create a new driver.
  3. Select "Custom" as the template.
  4. On the Driver Settings tab:
    • Set Name to a user-friendly name (e.g. "CData PingOne Driver")
    • Set URL Format to jdbc:pingone:
    • In Driver artifacts and jar files (jars are loaded in order from top):
      1. Click the plus sign "" -> "Add Files"
      2. Navigate to the "lib" folder in the installation directory (C:\Program Files\CData[product_name] XXXX\)
      3. Select the JAR file (cdata.jdbc.PingOne.jar) and click "Open"
  5. The Driver Class should populate automatically. If not, select class (cdata.jdbc.pingone.PingOneDriver).

Define the Connection to the JDBC Data Source

Close the "Driver Manager" and follow the steps below to save connection properties in the JDBC URL.

  1. In the "Databases" tab, click the plus sign "" and select the driver you just created.
  2. In the "Connection" section, set the following options:

    • Database Type: If you selected the wizard option, the database type is automatically detected. If you selected the "No Wizard" option, select the Generic or Auto Detect option in the Database Type menu.
    • Driver Type: Select the driver you just created.
    • Database URL: Enter the full JDBC URL. The syntax of the JDBC URL is jdbc:pingone: followed by the connection properties in a semicolon-separated list of name-value pairs.

      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:

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

      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 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.

      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.

      When you configure the JDBC URL, you may also want to set the Max Rows connection property. This will limit the number of rows returned, which is especially helpful for improving performance when designing reports and visualizations.

      A typical connection string is below:

      jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH
    • NOTE: Since PingOne does not require a User or Password to authenticate, you may use whatever values you wish for Database Userid and Database Password.
  3. On the Connection tab, click Connect.

To browse through tables exposed by the PingOne JDBC Driver, right-click a table and click "Open in New Tab."

To execute SQL queries, use the SQL Commander tool: Click SQL Commander -> New SQL Commander. Select the Database Connection, Database, and Schema from the available menus.

See the "Supported SQL" chapter in the help documentation for more information on the supported SQL. See the "Data Model" chapter for table-specific information.

More Information & Free Trial

Download a free, 30-day trial of the CData JDBC Driver for PingOne and start working with your live PingOne data in DbVisualizer. Join the CData Community or reach out to our Support Team if you have any questions.

Ready to get started?

Download a free trial of the PingOne Driver to get started:

 Download Now

Learn more:

PingOne Icon PingOne JDBC Driver

Rapidly create and deploy powerful Java applications that integrate with PingOne.