The endpoints in the Integration Catalog enable developers to discover and retrieve integration metadata and download integration kits as a compressed file. Administrator-level access adds the ability to create and change integration metadata, as well as upload compressed integration kits.

Integrations data model

Property Type Description
_links HAL links Relevant endpoints for the current environment and integrations.
_links.self.href HAL link URL for the current endpoint.
_links.environment.href HAL link URL for the current environment.
_links.versions.href HAL link URL for the current integration versions.
_embedded.versions array[versions] Present when the expand parameter is set. Lists the versions of the current integration.
id UUID The platform-generated ID of this integration.
name string Name of the integration.
thirdParty object Metadata that defines the third party related to this integration.
thirdParty.company object Object that defines the third-party company.
thirdParty.company.name string Name of the third-party company.
thirdParty.products array[string] An array of names of the third-party products for the integration.
publisher string Name of the integration publisher.
tags array[string] Tags to apply to the integration metadata. Can include: SSO, AUTHENTICATION, MFA, INTELLIGENCE, GOVERNANCE, IDAAS, ACCESS, DIRECTORY, or PROVISIONING.
pingProductNames array[string] The Ping product associated with the integration. Can include: PINGID, PINGONE_ENTERPRISE, PINGONE, PINGACCESS, PINGFEDERATE, PINGDIRECTORY, PINGDATAGOVERNANCE, orPINGINTELLIGENCE_FOR_APIS. Default is PINGONE.
createdAt date Creation date of the integration.
marketingLandingPageUrl string Absolute URL link to the marketing landing page.
categories array[string] A list of categories with which to classify the integration.

Versions

Each integration can have versions. Valid integration version numbers match the regular expression (^\d+.\d+(.\d+)?$). So, 1.0.2 and 2.06 are valid versions. Examples of invalid versions include v.1.2 and 1.2.3.4.

Integration Version data model

Property Type Description
_links HAL links Relevant endpoints for the current environment and integrations.
_links.self.href HAL link URL for the current endpoint.
_links.integration.href HAL link URL for the current environment and integration.
id UUID Platform-generated ID of this integration metadata version.
name string Unique name for the integration metadata version. Uniqueness must persist between versions of separate integrations, as well.
description string Description of this integration metadata version.
integration object Parent of this integration metadata version.
integration.id UUID The ID of the parent integration.
type string Type of integration for this version. Currently, the only valid strings are PRODUCT_INTEGRATION_KIT (default) and SAML.

Integration Kit data model (extends Integration Version)

Integration version metadata with a type of PRODUCT_INTEGRATION_KIT will include the following data.

Property Type Description
number string Unique number for the integration version.
endOfLifeOn date EOL support date in the form yyyy-mm-dd.
integratedWith object Ping product integration details.
integratedWith.name string Name of the compatible Ping product with which this version integrates. Can include: PINGID, PINGONE_ENTERPRISE, PINGONE, PINGACCESS, PINGFEDERATE, PINGDIRECTORY, or PINGDATAGOVERNANCE
integratedWith.minVersion string Earliest version of the integrated Ping product.
integratedWith.maxVersion string Latest version of the integrated Ping product.
releasedOn date Release date in the form yyyy-mm-dd.
documentationUrl string Absolute URL to the documentation.

SAML data model (extends Integration Version)

Integration version metadata with a type of SAML will include the following data.

Property Type Description
protocolVersion string The SAML protocol version supported: 2.0, 1.1, or 1.0.
assertionConsumerService string (max length 2000) The URL to which PingOne sends SAML responses. Parameterize the URL using ${paremter}. For example, https://${subdomain}.slack.com.
entityId string Unique ID for the application.
targetResource string (max length 2000) RelayState value in the generated SAML response. Informs the IdP where to send its response. Parameterize the URL using ${paremter}. For example, https://${subdomain}.slack.com.
slo.requestEndpoint string The endpoint where SLO requests are sent.
slo.responseEndpoint string The endpoint where SLO responses are sent.
slo.binding string The SLO binding. Must be either HTTP_POST or HTTP_REDIRECT
assertionEncrypted Boolean The state of assertion encryption. True if encrypted.
thirdParty.metadata.href string URL of IdP’s SAML metadata XML.
thirdParty.instructions.href string URL of IdP’s setup instruction.

Attribute data model

Only available for SAML integration metadata, Attribute data stores the attributes that providers predefine.

Property Type Description
_links.self HAL link HREF for this attribute.
_links.version HAL link HREF to parent version.
id UUID Auto-generated ID of this attribute.
version.id UUID ID of the parent version.
name string Attribute name the application expects. Unique within the integration version and in the form urn:oasis:names:tc:SAML:2.0:attrname-format:uri.
required Boolean Whether or not the attribute is required. If true, the value property must be set with a non-empty value. Default is false.