Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From PingOne connection/s to launch the CData Query window. To setup a new connection, you will have to click the New PingOne Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting 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.

First, find the value for this property:

From the home page of your PingOne organization, move to the navigation sidebar and click Environments.
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.
In the environment's home page navigation sidebar, click Applications.
Find your OAuth or Worker application details in the list.
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

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.
To ensure that the add-in 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.
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:

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 add-in opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application.

OAuthClient (Client Credentials grant)

Set AuthScheme to OAuthClient.

Automatic OAuth

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

OAuthClientId: The OAuth Client ID in your custom OAuth application settings.
OAuthClientSecret: The OAuth Secret in your custom OAuth application settings.

When you connect, the add-in automatically completes the OAuth process:

The add-in obtains an access token from PingOne and uses it to request data.
The add-in refreshes the access token automatically when it expires.
The OAuth values are saved in memory at the location specified in OAuthSettingsLocation.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to PingOne you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

Excel Add-In for PingOne