---
title: Web service interfaces and APIs
description: PingFederate provides two built-in, SOAP-accessible web services related to browser-based single sign-on (SSO).
component: pingfederate
version: 12.2
page_id: pingfederate:developers_reference_guide:pf_web_service_interface_api
canonical_url: https://docs.pingidentity.com/pingfederate/13.1/developers_reference_guide/pf_web_service_interface_api.html
llms_txt: https://docs.pingidentity.com/pingfederate/llms.txt
docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md
revdate: September 28, 2026
superseded_by: https://docs.pingidentity.com/pingfederate/13.1/developers_reference_guide/pf_web_service_interface_api.html
---

# Web service interfaces and APIs

PingFederate provides two built-in, SOAP-accessible web services related to browser-based single sign-on (SSO).

These services can be used by client applications to manage partner connections and support integration of web applications, respectively.

* Connection Management Service

|   |                                                                                                                         |
| - | ----------------------------------------------------------------------------------------------------------------------- |
|   | As of PingFederate 10.2, the Connection Management Service has been deprecated and will be removed in a future release. |

The Connection Management Service enables creation and deletion of single connection configurations in PingFederate. This service can be used to migrate connections from one server environment to another, for example, from testing or staging to production, or to create new connections in a single server programmatically.

|   |                                                                                                                                                                                                                                                                                                                               |
| - | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | PingFederate provides a command-line utility that can be used to export and modify connections, as well as other administrative-console configurations, and then import them into target environments. Learn more in [Automating configuration migration](../administrators_reference_guide/pf_automatin_config_migrat.html). |

* SSO Directory Service

|   |                                                                                                                 |
| - | --------------------------------------------------------------------------------------------------------------- |
|   | As of PingFederate 10.2, the SSO Directory Service has been deprecated and will be removed in a future release. |

The SSO Directory Service provides web application developers with information regarding partner connections and adapter instances.

|   |                                                                                                                                                                                                                                                                                                                                                                            |
| - | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | Applications accessing the Connection Management Service must first authenticate themselves to the PingFederate server. SSO Directory Service authentication is optional by default, but might be required. Learn more in [Configuring service authentication](../administrators_reference_guide/help_manageserviceauthenticationtasklet_serviceauthenticationstate.html). |

Additionally, PingFederate provides REST-based web services and APIs for a variety of administrative and runtime tasks.

* OAuth Client Management Service

  A runtime API to manage OAuth client applications.

  Learn more in [OAuth Client Management Service](pf_oauth_client_manage_service.html).

* OAuth Access Grant Management Service

  A runtime API to retrieve and revoke persistent grants. This API is intended for administrators to manage grants per client or per user.

  Learn more in [OAuth Access Grant Management Service](pf_oauth_access_grant_manage_service.html).

* OAuth Consent Management Service

  A REST-based web service to retrieve and revoke OAuth consent for a client or resource owner.

  Learn more in [OAuth Consent Management Service](pf_oauth_consent_management_service.html).

* OAuth Persistent Grant Management API

  Another runtime API to retrieve and revoke persistent grants. This API is intended for the use case where clients can assume the responsibility of grant management, provided that the users authorize the clients to do so.

  Learn more in [OAuth Persistent Grant Management API](pf_oauth_persist_grant_manage_api.html).

* Session Management API by session identifiers

  A runtime API that lets OAuth clients get information about user sessions, extend sessions, revoke sessions, and delete sessions.

  Learn more in [Session Management API by session identifiers](pf_sess_manage_api_sess_identif.html).

* Session Management API by user identifiers

  A runtime API for OAuth applications to query or revoke authentication sessions belonging to an end-user.

  Learn more in [Session Management API by user identifiers](pf_sess_manage_api_user_identif.html).

* Session Revocation API

  A runtime API allowing clients supporting the OpenID Connect protocol to query revocation status of their sessions and add sessions to the revocation list.

  Learn more in [Session Revocation API endpoint](pf_session_revocation_api_endpoint.html).

* PingFederate administrative API

  An administrative API to manage various PingFederate settings.

  Learn more in [PingFederate administrative API](pf_admin_api.html).

* OAuth Playground

  A developer tool for experimenting with OAuth and OpenID Connect.

  Learn more in [OAuth Playground](pf_oauth_playground.html).
