Click Protocol Endpoints in the Service Provider menu to see a list of applicable OpenID Connect, SAML, WS-Federation, and WS-Trust STS endpoints—a pop-up window displays only those endpoints related to the federation protocols enabled on the screen. These endpoints are built into PingFederate and cannot be changed.
Your federation partners or STS clients need to know the applicable SP services endpoints to communicate with your PingFederate server. Configured service endpoints for SAML connections are included in metadata export files.
PingFederate provides a favorite icon for all protocol endpoints. For more information, see Customizing the favicon for application and protocol endpoints.
The table below describes each endpoint:
|Service||URL and Description|
|Third Party Initiated Login (OpenID Connect 1.0)||
The URL that receives and processes login requests initiated by an OpenID Provider (OP) or another party. This protocol endpoint supports HTTP GET and POST methods and the following parameters:
Other parameters (if any) are not sent to the OP unless they are defined with a default value (or default values) in the IdP connection (see Configuring request parameters and SSO URLs).
For more information about Third Party Initiated Login flow, see the OpenID Connect specification (openid.net/specs/openid-connect-core-1_0.html#ThirdPartyInitiatedLogin).
|Single Logout Service (SAML 2.0)||
The URL that receives and processes logout requests and responses.
|Assertion Consumer Service (SAML 2.0)||
A SAML 2.0 implementation that receives and processes assertions from an IdP. The numbers reflect the index value PingFederate uses to handle each binding.
|Artifact Resolution Service (SAML 2.0)||
The SOAP endpoint that processes artifacts returned from a federation partner to retrieve the referenced XML message on the back channel. (See the Important note at the end of this table.)
|Assertion Consumer Service (SAML 1.x)||
A SAML 1.x implementation URL that receives and processes assertions from an IdP.
|Single Sign-on Service (WS-Federation)||
The WS-Federation implementation URL that receives and processes security tokens and SLO messages.
|WS-Trust STS (two endpoints)||
The SOAP endpoint that receives and processes SAML security-token requests from STS clients (web service providers at the SP site), validating SAML tokens or validating and exchanging SAML tokens based on the configured IdP connection.
Initiates direct STS token-to-token exchange and token validation, from an IdP token processor to an SP token generator, when that feature is configured (see Token translator mappings).
If multiple token-generator instances of the same type are configured for the same connection or token-to-token mapping, a query parameter, TokenGeneratorId, must be added to either of these endpoints—see Managing token generators.
(See the Important note at the end of this table.)
If mutual SSL/TLS is used for authentication, a secondary PingFederate listening port must be configured and used by partners or STS clients for the relevant endpoints—*.ssaml* and *.wst (see Configuring PingFederate properties).
Virtual server ID support
For SAML connections using multiple virtual server IDs (see Multiple virtual server IDs), each virtual server ID has its own set of protocol endpoints. You may export a connection metadata for your partner on the screen (see Exporting connection-specific SAML metadata).
For WS-Federation (and SAML) connections using multiple virtual server IDs, you may provide your partner the federation metadata endpoint (/pf/federation_metadata.ping) with the PartnerIdpId and vsid parameters; for example:
|Partner's entity ID||Your virtual server ID||Federation metadata URL|
(In this example, the base URL and the runtime port of your PingFederate server are www.example.com and 443, respectively.)
The federation metadata endpoint returns information that is specific for a given virtual server ID (when the request includes the vsid parameter).
For WS-Trust STS, you may provide your partner the STS metadata endpoint (/pf/sts_mex.ping) with the PartnerIdpId and vsid parameters. The STS metadata endpoint returns information that is specific for a given virtual server ID (when the STS metadata request includes the vsid parameter).
(For more information about these metadata endpoints, see System-services endpoints.)
Note that the virtual server ID concept does not apply to the /pf/sts.wst endpoint because token-to-token exchange does not involves any connections. As needed, you may pass the token-to-token endpoint to your partners as-is.