Access PingOne Data from MySQL in HeidiSQL

HeidiSQL is an open-source database administration tool that natively supports MariaDB, MySQL, SQL Server, and PostgreSQL. When paired with the CData ODBC Driver for PingOne and SQL Gateway, HediSQL's reach extends to include access to live PingOne data. This article demonstrates how to connect to on-premise PingOne and query PingOne data in HeidiSQL.

Connect to PingOne Data

If you have not already done so, provide values for the required connection properties in the data source name (DSN). You can use the built-in Microsoft ODBC Data Source Administrator to configure the DSN. This is also the last step of the driver installation. See the "Getting Started" chapter in the help documentation for a guide to using the Microsoft ODBC Data Source Administrator to create and configure a DSN.

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.

When you configure the DSN, 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.

Configure the SQL Gateway

See the SQL Gateway Overview to set up connectivity to PingOne data as a virtual MySQL database. You will configure a MySQL remoting service that listens for MySQL requests from clients. The service can be configured in the SQL Gateway UI.

👁 Creating a MySQL Remoting Service in SQL Gateway (Salesforce is shown)

To connect to the SQL Gateway from HeidiSQL, you will need to run the SQL Gateway on a web-facing machine. After configuring the SQL Gateway, make note of the following information:

• The IP address or domain name of the machine hosting the SQL Gateway
• The data source name (likely CData PingOne Sys) of the MySQL service
• The port number of the MySQL service
• The credentials of a SQL Gateway user with access to the service

Configure Remote Access

If your ODBC Driver and the remoting service are installed on-premise (and not accessible from HeidiSQL), you can use the reverse SSH tunneling feature to enable remote access. For detailed instructions, read our Knowledge Base article: SQL Gateway SSH Tunneling Capabilities.

Connect to PingOne in HeidiSQL

Once you have a MySQL Service configured for the CData ODBC Driver for PingOne, you are ready to connect to the data in HeidiSQL. Start by creating a new connection Session in HeidiSQL, then choose the MySQL library type.

Configure the data set using the values for the MySQL service for PingOne you configured in SQL Gateway (be sure to use the DSN for the database name). Validate your connection and click Open.

👁 Configure the connection to SQL Gateway.

Query PingOne from HeidiSQL

1. In the database listing on the left, find your connection to PingOne configured earlier.
2. In the database listing on the left, expand the appropriate connection and to view individual tables or data objects present within PingOne.
3. Write custom SQL queries targeting these tables, treating the data source like any SQL Server database, or visually explore each tabular data set by selecting the relevant tables 👁 Querying within HeidiSQL.
   

With the CData ODBC Driver for PingOne and SQL Gateway, you are able to easily query data from PingOne data in HeidiSQL. If you have any questions, such as needing to access your on-premises data from HeidiSQL, let our Support Team know.