One-Time Passcode Integration Kit

Deploying the integration files

To get started with the integration, deploy the One-Time Passcode Integration Kit files to your PingFederate directory.

Before you begin

Download the integration kit .zip archive from the Add-ons tab on the PingFederate downloads page or the Ping Identity Marketplace.

Steps

  1. Stop PingFederate, if it’s running.

  2. If you’re upgrading from a previous deployment, do the following:

    1. Back up any One-Time Passcode Integration Kit files you customized in <pf_install>/pingfederate/server/default/conf/.

    2. Delete pf-one-time-passcode-adapter-<version>.jar from <pf_install>/pingfederate/server/default/deploy.

    3. Delete pf-authn-api-sdk-<version>.jar from <pf_install>/pingfederate/server/default/lib if it’s older than the version in the integration files.

  3. Extract the .zip archive and copy the contents of the dist directory to <pf_install>.

  4. If you want to use the SMTP Notification Publisher, merge the contents of the pingfederate-smtp-otp-messages.properties file into the <pf_install>/pingfederate/server/default/conf/language-packs/pingfederate-email-messages.properties file.

  5. If you backed up templates or messages from a previous deployment, modify the new files with your customizations.

  6. Start PingFederate.

  7. If you operate PingFederate in a cluster, repeat steps 1 - 6 for each instance of PingFederate.