Install the PingID Integration Kit

Why You're Here

Your organization is using PingID as an authentication solution for federated single sign-on (SSO) with PingFederate®.

PingID Integration Kit Requirements
  • You've registered for the PingID Enterprise service on PingOne.
  • You've configured the PingID service and downloaded the PingID settings file. See Configure the PingID Service.
  • PingFederate version 7.1.0 or higher.
  • Network access to a PingFederate installation.
  • Open ports:
    • 443 (in external firewall)
    • 1812 (in internal firewall)
  • Administrator permissions on PingFederate.
What You'll Do

The PingID Integration Kit is bundled as part of PingFederate 8.2 and later, and no further action is required. If you are using an earlier version of PingFederate, or updating the PingID Integration Kit, proceed with the following steps.

You'll stop the PingFederate server, copy the necessary files from the PingID Integration Kit, and restart the PingFederate server.

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

  2. Remove any previous PingID Integration Kit version files in the pingfederate-installation/server/default/deploy directory.

    NotePingID Integration Kit versions below 1.5 included common-mfa-<version>.jar, gson-<version>.jar, and jose4j-<version>.jar, which should be removed as part of this step.
  3. Copy the following files from the PingID Integration Kit /dist directory to the pingfederate-installation/server/default/deploy directory:

    • pf-pingid-idp-adapter-1.5.0.jar
    • (PingFederate versions prior to 7.3 only)
      • LDAPExtendedAttributesPCV-1.5.0.jar
      • PingIDRadiusPCV-1.5.0.jar
    • (PingFederate version 7.3+ only) PingIDRadiusPCV-1.5.0.jar
  4. Deploy the jose4j jar:

    NoteDeploy the jose4j jar, only if both the following apply:
    • The PingID adapter version is older than 1.4
    • The PingFederate version is from 7.1 or 7.1.x (not applicable to 7.1 Rx or later)
    1. Delete the jose4j JAR file located in pingFedInstallPath/server/default/lib.

    2. Delete any jose4j JAR located in pingFedInstallPath/server/default/deploy.

    3. Copy jose4j-0.3.3.jar from the integration-kit /dist directory to pingFedInstallPath/server/default/lib.

    4. Rename the jose4j-0.3.3.jar file you copied (in pingFedInstallPath/server/default/lib) to "jose4j.jar".

  5. Restart the PingFederate server.

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