Whether you export a connection manually or programmatically, the exported XML complies with the standard SAML 2.0 metadata format, with extensions to capture PingFederate's proprietary configuration. Most connection configuration information is contained in the XML markup, with the exception of global configuration items such as adapter instances, datastores, and key pairs. Adapter instances and datastores are referenced by ID, and key pairs are referenced by the MD5 fingerprint of their X.509 certificate. Public certificates, such as the partner's signature verification certificate, are included completely (base-64 encoded).

Export manually

For information about using the administrative console to export connections, see Accessing SP connections or Accessing IdP connections.

Export via the Connection Management Service

The Connection Management Service exposes the following method for exporting connections.

public string getConnection( String entityId, String role,) throws IOException

The entityId parameter is the connection ID, which identifies the connection to be deleted. The role parameter is the connection role, the identity provider (IdP) or the service provider (SP).

Code sample

The following example invokes this web service to export a connection.
Service service = new Service();
Call call = (Call)service.createCall();
call.setUsername("username");
call.setPassword("password");
call.setTargetEndpointAddress("https://localhost:9999/pf-mgmt-ws/ws/ConnectionMigrationMgr");
call.setOperationName("getConnection");
Object result = call.invoke(new Object[] {"<entityId>", "SP"});