PingFederate Server

Upgrade considerations

The following modifications since PingFederate 13.0 might affect existing deployments.

OAuth client management service response format

If you use the in-place method to upgrade to PingFederate 13.0.3 or later, then the OAuth client management service will always return parameters that support multiple values as arrays, even when only a single value is returned.

To return single values as strings:

  1. Open the <pingfed-install>/pingfederate/server/default/data/config-store/com.pingidentity.ws.rest.oauth.client_management.model.converter.SerializerUtil.xml file in a text editor.

  2. Set the writeSingleItemElementAsArray parameter to false.

  3. Save and close the file.

Jersey 1.x plugin compatibility

Older plugins that depend on Jersey 1.x, such as older versions of the OAuth Playground, are not compatible with PingFederate. If you have an older version of the OAuth Playground installed, upgrade it to a version compatible with PingFederate 13.1, or delete it from your deployment directory before starting PingFederate. For PingFederate 13.1, use OAuthPlayground 6.0.

If your server.log contains an error similar to the following error, review the server/default/deploy directory. You must update or remove any plugin that relies on Jersey 1.x libraries.

Example error
java.lang.RuntimeException: java.lang.AbstractMethodError: Receiver class
com.sun.jersey.api.uri.UriBuilderImpl does not define orinherit an
implementation of the resolved method 'abstract javax.ws.rs.core.UriBuilder
uri(java.lang.String)'...
Jakarta EE 9 migration and plugin compatibility

Starting with version 13.1, PingFederate includes Jakarta EE 9 migration updates. If you have deployed other custom or third-party plugins in <pingfed-install>/pingfederate/server/default/deploy, update them to versions compatible with PingFederate 13.1 before starting the server.

pf.admin.baseurl must be set

A defect fix requires the pf.admin.baseurl property to be explicitly set in run.properties. This prevents admin console URL redirects from failing when PingFederate is accessed through a load balancer with a port that differs from pf.admin.https.port.

Removed support for Java 11

Starting with version 13.0, PingFederate no longer supports Java 11. Use Java 17 or Java 21 instead. In version 13.1, Java 25 is also supported.

Learn more in Java environment.

Upgrade from PingFederate 8.x

Starting with version 13.0, PingFederate no longer supports upgrading from 8.x.