Connect to PingOne Data as a SQL Server Linked Server

SQL Server Linked Servers enable the SQL Server Database Engine to read data from remote data sources and execute commands against the remote database servers outside of the instance of SQL Server. Typically, linked servers are configured to enable the execution of a T-SQL statement that includes tables in another instance of SQL Server, or another database product such as Oracle. When paired with CData Connect AI, linked servers provides instant access to PingOne data from your SQL Server database. This article demonstrates how to connect to PingOne using Connect AI and query PingOne data in SQL Server Management Studio (SSMS).

CData Connect AI provides a pure SQL Server interface for PingOne, allowing you to query data from PingOne without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to PingOne, leveraging server-side processing to return the requested PingOne data quickly.

Configure PingOne Connectivity for SQL Server

Connectivity to PingOne from SQL Linked Servers is made possible through CData Connect AI. To work with PingOne data from SQL Linked Servers, we start by creating and configuring a PingOne connection.

1. Log into Connect AI, click Sources, and then click Add Connection

2. Select "PingOne" from the Add Connection panel

3. Enter the necessary authentication properties to connect to PingOne.

   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.

   
4. Click Save & Test
5. Navigate to the Permissions tab in the Add PingOne Connection page and update the User-based permissions.

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
2. On the Settings page, go to the Access Tokens section and click Create PAT.
3. Give the PAT a name and click Create.
4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

With the connection configured and a PAT generated, you are ready to connect to PingOne data from .

Connect to PingOne from SQL Server using Connect AI

To establish a connection from SQL Server Linked Server to the CData Connect AI Virtual SQL Server API, follow these steps.

1. Open Microsoft SQL Server Management Studio.
2. In the Object Explorer pane, open Server Objects, right-click Linked Servers, and select New Linked Server.

3. The New Linked Server dialogue opens. On the General page, enter the following information:
   • Enter a name for the server in the Linked server field.
   • Select the radio button Other data source and select SQL Server Native Client 11.0 as the provider.
   • In the Data source field, enter tds.cdata.com,14333
   • In the Catalog field, enter enter the Connection Name of the CData Connect AI data source you want to connect to (for example, PingOne1).
   
4. Select the Security page. At the bottom, select the radio button labeled Be made using this security context and enter the following information:
   • Remote login - enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
   • With password - enter the PAT you generated on the Settings page.
   
5. Click OK to create the server.
Your linked server can now be used to access the data in the data source you specified. If you need to access data from more sources, create another linked server for each one.

Execute Queries

You can now execute queries to the PingOne linked server from any tool that can connect to SQL Server. An example SQL query would be:

		SELECT * FROM [CDATA CONNECT CLOUD].[PingOne1].[PingOne].[[CData].[Administrators].Users]
	

We have successfully created a linked server that allows us to query PingOne data.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from your SQL Server database, try CData Connect AI today!