Help Manual - Ping Identity Connection Manager

Documentation on SSIS Ping Identity Connection Manager component

Setup a Ping Identity REST Connection Manager

The REST Connection Manager is an SSIS connection manager component that can be used to establish connections with Ping Identity REST service to help facilitate Ping Identity data integration.

See Ping Identity REST Source Component for how to retrieve data from Ping Identity & Ping Identity REST Destination Component for how to write to Ping Identity.

To add a new connection, right-click the Connection Manager area in your Visual Studio project, and choose "New Connection..." from the context menu. You will be prompted the "Add SSIS Connection Manager" window. Select the "REST (KingswaySoft)" item to add a new REST Connection Manager.

New SSIS Connection

Add SSIS REST Connection Manager

The REST Connection Manager contains 2 pages of configuration.

  • General
  • Advanced Settings

General

The General page allows you to specify connection properties and login credentials for Ping Identity REST service:

SSIS REST Ping Identity Connection Manager

Service Name

The REST service that will be connected to.

Region

The Region selection for the instance you are connecting to.

API Throttle Rate

The API Throttling Rate will limit the number of requests that can be sent per second.

Environment ID

The Environment ID will be the ID of your environment.


Authentication Mode

There are two authentication modes:

  • Authorization Code
  • Client Credentials

Authorization Code

Generate Token File

This button allows you to login to the service endpoint and authorize your app to generate a token.

SSIS Ping Identity Connection Manager - Auth Page

Here you can enter the Client ID, Client Secret,  and Redirect URL which you may select any valid URL for the redirect. Enable PKCE for PKCE App Type. Enable Basic Auth  for basic authentication. The ellipsis button next to the scope helps in finding the right scopes.

  • Use Default Browser to Sign In:When this option is checked the Sign In and Authorize button will open your default web browser to complete the OAuth authentication. When this option is unchecked, the Sign In and Authorize button will complete the entire OAuth authentication process inside of the toolkit.
  • Sign In and Authorize:This button allows you to login to the service endpoint and authorize your app to generate a token.

Path To Token File

The path to the token file on the file system.


Token File Password

The password to the token file.


Client Credentials

 

Client Id

The Client Id that is generated from the Ping Identity authentication setup.

Client Secret

The Client Secret that is used for authentication.

Basic Authentication

When enabled sends client credentials over authentication header rather than request body.

Test Connection

After all the connection information has been provided, you may click the "Test Connection" button to test if the user credentials entered can connect to the selected REST service.

Advanced Settings

REST Connection Manager - Advanced

Proxy Mode

Proxy Mode option specifies how you want to configure the proxy server setting. There are three options available.

  • No Proxy
  • Auto-detect (Using system configured proxy)
  • Manual
Proxy Server

Using Proxy Server option allows you to specify the name of the proxy server for the connection.

Port

The Port option allows you to specify the port number of the proxy server for the connection.

Username (Proxy Server Authentication)

Username option (under Proxy Server Authentication) allows you to specify the proxy user account.

Password (Proxy Server Authentication)

Password option (under Proxy Server Authentication) allows you to specify the proxy user's password.

Note: The Proxy Password is not included in the connection manager's ConnectionString property by default. This is by design for security reasons. However, you can include it in your ConnectionString if you want to parameterize your connection manager. The format would be ProxyPassword=myProxyPassword; (make sure you have a semicolon as the last character). It can be anywhere in the ConnectionString.

Timeout

The number of seconds requests should wait before timing out.

Retry on Intermittent Errors

The retry on intermittent errors option determines if requests will be retried when there is an error. If this option is checked requests will be retried up to 3 times.

Ignore Certificate Errors

This option can be used to ignore SSL certificate errors when connecting to Ping Identity servers.

Warning: Enabling "Ignore Certificate Errors" option is generally NOT recommended, particularly for production environments. Unless there is a strong reason to believe the connection is secure - such as the network communication is only happening in an internal infrastructure - this option should be unchecked.