The endpoints in the Integration Catalog enable developers to discover and retrieve integration metadata and download integration kits as a compressed file.

Integration 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 attribute 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.companyName string Name of the third party company for the listing.
thirdParty.products array[string] An array of names of the third party products for the integration.
publisher string Name of the 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, PINGONE_ADVANCED_SERVICES
createdAt date Creation date of the integration.
marketingLandingPageUrl string Absolute URL link to the marketing landing page.

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.
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 string is PRODUCT_INTEGRATION_KIT
number string Unique number for the integration version.
releasedOn date Release date in the form yyyy-mm-dd.
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.
documentationUrl string Absolute URL to the documentation.