Establishing a Connection

The objects available within our connector are accessible from the "cdata.pingone" module. To use the module's objects directly:

Import the module as follows:
```
import cdata.pingone as mod
```

To establish a connection string, call the connect() method from the connector object using an appropriate connection string, such as:

mod.connect("AuthScheme=OAuth;InitiateOAuth=GETANDREFRESH;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=US;OAuthClientId=client_id;OAuthClientSecret=client_secret;")

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 connector 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:

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 connector opens PingOne's OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:

The connector obtains an access token from PingOne and uses it to request data.
The OAuth values are saved in the location specified in OAuthSettingsLocation, to be persisted across connections.

The connector refreshes the access token automatically when it expires.

Web Applications

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: The Client ID you obtained when you configured the custom OAuth application..
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Redirect URI you specified in your app settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in, and authorize the web application. After authenticating, the browser redirects you to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter.
Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the code parameter in the query string of the redirect URI.

After you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the connector automatically refresh the OAuth access token, set the following on the first data connection.

InitiateOAuth: REFRESH.
OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.
OAuthAccessToken: The access token returned by GetOAuthAccessToken.
OAuthRefreshToken: The refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: The location where you want the connector to save the OAuth values, which persist across connections.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token. Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver, use OAuth with a user account on a headless machine. You must authenticate on another device that has an internet browser.

Choose one of two options:

Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
Option 2: Install the connector on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

Then configure the connector to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an internet browser and obtain the OAuthVerifier connection property.

Set the following properties:
- InitiateOAuth: Set to OFF.
- OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
- OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.
Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the connector. You are then redirected to the redirect URI. There will be a parameter called code appended to the redirect URI. Note the value of this parameter. Later you will set this in the OAuthVerifier connection property.

Next, you must exchange the OAuth verifier code for OAuth refresh and access tokens.

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: REFRESH.
OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.
OAuthSettingsLocation: Specifies the location to which the encrypted OAuth authentication values should be persisted.

Test the connection to generate the OAuth settings file, then re-set the following properties to connect:

InitiateOAuth: REFRESH.
OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.
OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: REFRESH.
OAuthClientId: The Client ID you obtained when you configured the custom OAuth application.
OAuthClientSecret: The Client Secret you obtained when you configured the custom OAuth application.
OAuthSettingsLocation: The location of the OAuth settings file you copied from the machine with the browser. Make sure this location gives read and write permissions to the connector to enable the automatic refreshing of the access token.

OAuthClient (Client Credentials grant)

Set AuthScheme to OAuthClient.

Automatic OAuth