Access Live PingOne Data in AWS Lambda

AWS Lambda is a compute service that lets you build applications that respond quickly to new information and events. AWS Lambda functions can work with live PingOne data when paired with the CData JDBC Driver for PingOne. This article describes how to connect to and query PingOne data from an AWS Lambda function built in Eclipse.

At the time this article was written (June 2022), Eclipse version 2019-12 and Java 8 were the highest versions supported by the AWS Toolkit for Eclipse.

With built-in optimized data processing, the CData JDBC Driver offers unmatched performance for interacting with live PingOne data. When you issue complex SQL queries to PingOne, the driver pushes supported SQL operations, like filters and aggregations, directly to PingOne and utilizes the embedded SQL engine to process unsupported operations client-side (often SQL functions and JOIN operations). In addition, its built-in dynamic metadata querying allows you to work with and analyze PingOne data using native data types.

Gather Connection Properties and Build a Connection String

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.

NOTE: To use the JDBC driver in an AWS Lambda function, you will need a license (full or trial) and a Runtime Key (RTK). For more information on obtaining this license (or a trial), contact our sales team.

Built-in Connection String Designer

For assistance constructing the JDBC URL, use the connection string designer built into the PingOne JDBC Driver. 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 (including the RTK) and copy the connection string to the clipboard.

Create an AWS Lambda Function

1. Download the CData JDBC Driver for PingOne installer, unzip the package, and run the JAR file to install the driver.

2. Create a new AWS Lambda Java Project in Eclipse using the AWS Toolkit for Eclipse. You can follow the tutorial from AWS (amazon.com).

   For this article, set the Input Type for the project to "Custom" so we can enter a table name as the input.

   
3. Add the CData JDBC Driver for PingOne JAR file (cdata.jdbc.pingone.jar) to the build path. The file is found in INSTALL_PATH\lib\.
4. Add the following import statements to the Java class:

   import java.sql.Connection;
   import java.sql.DriverManager;
   import java.sql.ResultSet;
   import java.sql.ResultSetMetaData;
   import java.sql.SQLException;
   import java.sql.Statement;
   

5. Replace the body of the handleRequest method with the code below. Be sure to fill in the connection string in the DriverManager.getConnection method call.

   String query = "SELECT * FROM " + input;
   
   try {
   	Class.forName("cdata.jdbc.pingone.PingOneDriver");
   } catch (ClassNotFoundException ex) {
   	context.getLogger().log("Error: class not found");
   }
   
   Connection connection = null;
    
   try {
   	connection = DriverManager.getConnection("jdbc:cdata:pingone:RTK=52465...;AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;InitiateOAuth=GETANDREFRESH");
   } catch (SQLException ex) {
   	context.getLogger().log("Error getting connection: " + ex.getMessage());
   } catch (Exception ex) {
   	context.getLogger().log("Error: " + ex.getMessage());
   }
    
   if(connection != null)
   {
   	context.getLogger().log("Connected Successfully!\n");
   }
    
   ResultSet resultSet = null;
   try
   {
   	//executing query
   	Statement stmt = connection.createStatement();
   	resultSet = stmt.executeQuery(query);
   
   	ResultSetMetaData metaData = resultSet.getMetaData();
   	int numCols = metaData.getColumnCount();
   
   	//printing the results
   	while(resultSet.next())
   	{
   		for(int i = 1; i <= numCols; i++)
   		{
   			System.out.printf("%-25s", (resultSet.getObject(i) != null) ? resultSet.getObject(i).toString().replaceAll("\n", "") : null );
   		}
   		System.out.print("\n");
   	}
   }
   catch (SQLException ex)
   {
   	System.out.println("SQL Exception: " + ex.getMessage());
   }
   catch (Exception ex)
   {
   	System.out.println("General exception: " + ex.getMessage());
   }
    
   String output = "query: " + query + " complete";
   return output;
   

Deploy and Run the Lambda Function

Once you build the function in Eclipse, you are ready to upload and run the function. In this article, the output is written to the AWS logs, but you can use this is a template to implement you own custom business logic to work with PingOne data in AWS Lambda functions.

1. Right-click the Package and select Amazon Web Services -> Upload function to AWS Lamba.
2. Name the function, select an IAM role, and set the timeout value to a high enough value to ensure the function completes (depending on the result size of your query).
3. Right-click the Package and select Amazon Web Services -> Run function on AWS Lambda and set the input to the name of the PingOne object you wish to query (i.e. "[CData].[Administrators].Users").
4. After the job runs, you can view the output in the CloudWatch logs.

Free Trial & More Information

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