Query PingOne Data in ColdFusion

The CData JDBC driver for PingOne seamlessly integrates connectivity to PingOne data with the rapid development tools in ColdFusion. This article shows how to connect to PingOne data in ColdFusion and query PingOne tables.

Create a JDBC Data Source for PingOne in ColdFusion

The JDBC data source enables you to execute SQL from standard ColdFusion tags like cfquery and CFScript like executeQuery.

1. Copy the driver JAR and .lic file from the installation directory onto the ColdFusion classpath. For example, copy the files into C:\MyColdFusionDirectory\cfusion\wwwroot\WEB-INF\lib. Or, open the Java and JVM page in the ColdFusion Administrator and enter the path to the files in the ColdFusion Class Path box.

   The JAR and license for the driver are located in the lib subfolder of the installation directory.

   Restart the server after this step.

2. Add the driver as a data source:

   From the ColdFusion administrator interface, expand the Data & Services node and click Data Sources. In the Add New Data Source section, enter a name for the data source and select Other in the Driver menu.

   

3. Populate the driver properties:

   • JDBC URL: Enter connection properties in the JDBC URL. The JDBC URL begins with jdbc:pingone: and is 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.

     

     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
   • Driver Class: Enter the driver class. The driver class is cdata.jdbc.pingone.PingOneDriver.
   • Driver Name: Enter a user-defined name for the driver.
   • Username: Enter the username used to authenticate.
   • Password: Enter the password used to authenticate.

You can now test the connection by enabling the CData PingOne data source in the Actions column. After reporting a status of OK, the PingOne data source is ready for use.

Execute Queries

The cfquery tag can pass SQL statements to PingOne. Use the cfqueryparam tag to create parameterized queries and prevent SQL injection through the query string.

Note: To use the cfquery and cfscript, create a .cfm file. Inside the .cfm file, write the code to execute the query (see below). Place the file directly in the root directory of your web server (e.g., wwwroot in Adobe ColdFusion). Restart the service after placing the file for the changes to take effect.

Below is the equivalent in CFScript:

<cfscript>
result = queryExecute(
  "SELECT * FROM [CData].[Administrators].Users WHERE EmployeeType = ?", 
  [
    { value="Contractor", cfsqltype="cf_sql_varchar" }
  ],
  { datasource="CDataPingOne" }
);

writeDump( var= result );
</cfscript> 

You can then make requests to your .cfm like the following: