With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our PingOne Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

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:

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

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

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

1. 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.
2. Log in and grant permissions to the cmdlet. 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 cmdlet 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 cmdlet to enable the automatic refreshing of the access token.

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 cmdlet automatically completes the OAuth process:

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

Creating a Connection Object

You can then use the Connect-PingOne cmdlet to create a connection object that can be passed to other cmdlets:

$conn = Connect-PingOne -AuthScheme 'OAuth' -WorkerAppEnvironmentId 'eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e' -Region 'NA' -OAuthClientId 'client_id' -OAuthClientSecret 'client_secret'

Retrieving Data

The Select-PingOne cmdlet provides a native PowerShell interface for retrieving data:

$results = Select-PingOne -Connection $conn -Table "[CData].[Administrators].Users" -Columns @("Username, Email") -Where "Id='39ef9b6f-5973-4701-bd19-7950d4b7d6e0'"

The Invoke-PingOne cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file:

Select-PingOne -Connection $conn -Table [CData].[Administrators].Users -Where "Id = '39ef9b6f-5973-4701-bd19-7950d4b7d6e0'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\my[CData].[Administrators].UsersData.csv -NoTypeInformation

You will notice that we piped the results from Select-PingOne into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON:

 
PS C:\> $conn  = Connect-PingOne -AuthScheme 'OAuth' -WorkerAppEnvironmentId 'eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e' -Region 'NA' -OAuthClientId 'client_id' -OAuthClientSecret 'client_secret'
PS C:\> $row = Select-PingOne -Connection $conn -Table "[CData].[Administrators].Users" -Columns (Username, Email) -Where "Id = '39ef9b6f-5973-4701-bd19-7950d4b7d6e0'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "[CData].[Administrators].Users",
  "Columns":  [

  ],
  "Username":  "MyUsername",
  "Email":  "MyEmail"
} 

Deleting Data

The following line deletes any records that match the criteria:

Select-PingOne -Connection $conn -Table [CData].[Administrators].Users -Where "Id = '39ef9b6f-5973-4701-bd19-7950d4b7d6e0'" | Remove-PingOne

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into PingOne, checking first whether a record already exists and needs to be updated instead of inserted.

Import-Csv -Path C:\My[CData].[Administrators].UsersUpdates.csv | %{
  $record = Select-PingOne -Connection $conn -Table [CData].[Administrators].Users -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-PingOne -Connection $conn -Table [CData].[Administrators].Users -Columns @("Username","Email") -Values @($_.Username, $_.Email) -Where "Id  = `'$_.Id`'"
  }else{
    Add-PingOne -Connection $conn -Table [CData].[Administrators].Users -Columns @("Username","Email") -Values @($_.Username, $_.Email)
  }
}