Build a PostgreSQL Interface for PingOne Data using the CData JDBC Driver

There are a vast number of PostgreSQL clients available on the Internet. From standard Drivers to BI and Analytics tools, PostgreSQL is a popular interface for data access. Using our JDBC Drivers, you can now create PostgreSQL entry-points that you can connect to from any standard client.

To access PingOne data as a PostgreSQL database, use the CData JDBC Driver for PingOne and a JDBC foreign data wrapper (FDW). In this article, we compile the FDW, install it, and query PingOne data from PostgreSQL Server.

Connect to PingOne Data as a JDBC Data Source

To connect to PingOne as a JDBC data source, you will need the following:

• Driver JAR path: The JAR is located in the lib subfolder of the installation directory.

• Driver class:

  cdata.jdbc.pingone.PingOneDriver
  

• JDBC URL: The URL must start with "jdbc:pingone:" and can include any of the connection properties in name-value pairs separated with semicolons.

  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.

  👁 Using the built-in connection string designer to generate a JDBC URL (Salesforce is shown.)
  

  A typical JDBC URL is below:

  jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;
  

Build the JDBC Foreign Data Wrapper

The Foreign Data Wrapper can be installed as an extension to PostgreSQL, without recompiling PostgreSQL. The jdbc2_fdw extension is used as an example (downloadable here).

1. Add a symlink from the shared object for your version of the JRE to /usr/lib/libjvm.so. For example:

   ln -s /usr/lib/jvm/java-6-openjdk/jre/lib/amd64/server/libjvm.so /usr/lib/libjvm.so
   

2. Start the build:

   make install USE_PGXS=1
   

Query PingOne Data as a PostgreSQL Database

After you have installed the extension, follow the steps below to start executing queries to PingOne data:

1. Log into your database.
2. Load the extension for the database:

   CREATE EXTENSION jdbc2_fdw;
   

3. Create a server object for PingOne:

   CREATE SERVER PingOne 
   FOREIGN DATA WRAPPER jdbc2_fdw OPTIONS (
   drivername 'cdata.jdbc.pingone.PingOneDriver',
   url 'jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH;',
   querytimeout '15',
   jarfile '/home/MyUser/CData/CData\ JDBC\ Driver\ for\ Salesforce MyDriverEdition/lib/cdata.jdbc.pingone.jar'); 
   

4. Create a user mapping for the username and password of a user known to the MySQL daemon.

   CREATE USER MAPPING for postgres SERVER PingOne OPTIONS (
   username 'admin', 
   password 'test');
   

5. Create a foreign table in your local database:

   postgres=# CREATE FOREIGN TABLE [cdata].[administrators].users (
   [cdata].[administrators].users_id text,
   [cdata].[administrators].users_Id text,
   [cdata].[administrators].users_Username numeric) 
   SERVER PingOne OPTIONS (
   table_name '[cdata].[administrators].users');
   

You can now execute SELECT commands to PingOne:

postgres=# SELECT * FROM [cdata].[administrators].users;