PingOne Platform APIs

Reference

This section provides reference information for the PingOne Platform API. Topics include:

  • Error codes

    Provides a list of common PingOne top-level and detail API error messages. The error response includes a high-level error code and optional details containing specific information on how to resolve the issue.

  • Query parameter quick reference

    Provides a quick reference to show the SCIM operators that apply to a given PingOne endpoint operation. It also provides information about endpoint operations that support the limit, order, and expand filters.

  • Paging, ordering, and filtering collections

    Provides general information about paging, ordering, and filtering large collections.

  • Password encoding

    Provides the list of Key Derivation Functions (KDF) and crytographic ciphers as methods for password encoding that PingOne supports.

  • TLS and cipher suite requirements

    Provides information about TLS and cipher suite requirements for the auth.pingone.com and api.pingone.com domains.

  • External transaction and session IDs

    Provides information about custom HTTP headers across all endpoints that help track transactions in PingOne. These are optional headers to correlate with your own transactions and sessions.

  • PingOne Localization

    Provides information about localization in PingOne, including how PingOne services use the end user’s browser settings as a factor to determine which language to present to users.

  • Load Testing

    Provides guidelines that will help you conduct load testing in a way that will yield accurate results based on your service level agreement (SLA) and the inherent limits of the PingOne platform.

  • PingOne Platform Limits

    A link to the topic in the PingOne Admin Guide that describes the PingOne platform limits.

  • Roles and Permissions in PingOne

    Provides a list (and descriptions) of the PingOne built-in roles, and a list of PingOne role permissions that can be used to define custom roles.

  • Audit Reporting Events

    Provides a list of all PingOne audit reporting events by event type and event name.

The following reference topics are available in PingOne for Developers Foundations:

  • Conventions

    Includes detailed information about PingOne API requests and responses.

  • Platform security

    Lists the measures taken to ensure the continued resiliency and security of the PingOne platform, as well as measures you can take in this regard for your deployment and applications.