PingID Administration Guide

Installing the PingID SDK Integration Kit for PingFederate

Install the PingID SDK integration kit for single sign-on (SSO) with PingFederate.

Before you begin

Your organization is using PingID SDK as an authentication solution for federated SSO with PingFederate.

PingID SDK integration kit requirements:

  • Register for the PingID Enterprise service on PingOne.

  • Configure the PingID service and download the PingID SDK properties file. For more information, see Distributing the PingID SDK settings file and application ID.

  • PingFederate 8.2 or later.

    If your installation should support integration with the PingFederate Authentication API, the following minimum software versions are required:

    • PingFederate 9.3+

    • PingID SDK adapter 1.7+ for PingFederate

  • Network access to a PingFederate installation.

  • Open ports:

    • 443 (in external firewall)

    • 1812 (in internal firewall)

  • Administrator permissions on PingFederate.

About this task

The PingID SDK integration kit is part of the PingID SDK package. Download the full PingID SDK package, including the PingID SDK integration kit from https://www.pingidentity.com/en/resources/downloads/pingid.html.

Steps

  1. Extract the integration kit package.

    The integration kit includes the following directories:

    • dist: The PingID SDK adapter for SSO using PingFederate, the PingID SDK selector, the default HTML sign-on template, and language support.

    • legal: Legal details, attributions, copyrights, patents, and licenses.

  2. On the PingFederate host, stop the PingFederate server if it is running.

  3. Remove any previous PingID SDK integration kit version files in the <pingfederate-installation>/server/default/deploy directory.

  4. Copy the following files from the <PingID SDK Integration Kit>/dist directory to the <pingfederate-installation>/server/default/deploy directory:

    • pf-pingid-sdk-idp-adapter-<version>.jar

    • pf.plugin.pingid-sdk-idp-selector-<version>.jar

    • pingid-sdk-web.war

  5. Copy pingid.sdk.login.template.html to <pingfederate-installation>/server/default/conf/template.

  6. Copy pingid-sdk-messages_en.properties to <pingfederate-installation>/server/default/conf/language-packs.

  7. If <pingfederate-installation>/server/default/lib/pf-authn-api-<version>.jar is older than the pf-authn-api-<version>.jar in the PingID SDK Integration Kit, replace it with the pf-authn-api-<version>.jar from the PingID SDK Integration Kit.

  8. If you want to use the PingFederate Authentication API, merge the contents of the authn-api-messages.properties file from the PingID SDK Integration Kit into the <pingfederate-installation>/server/default/conf/language-packs/authn-api-messages.properties file.

  9. Restart the PingFederate server.

  10. If PingFederate is deployed on clustered servers, repeat these steps for all PingFederate nodes.