PingCentral API Reference

Applications

The application management API endpoints support operations to manage application resources, including designating an application owner and promoting the application from a development environment to production.

You can revert applications to previously promoted versions. The reverted versions of the application will not exist outside of PingCentral until you promote them again.

Applications data model

Property Description

applicationOwners

An array of strings that specifies the list of application owners. This is a required property.

applicationOwnerGroups

A string array of PingCentral groups that are application owners. This property is only applicable if PingCentral is configured in SSO mode.

created

A string that specifies the creation date for the application resource.

description

A string that provides a description of the resource.

enabled

A boolean that specifies whether the PingCentral application is enabled.

environmentId

A string that specifies the environment associated with the resource.

id

A string that specifies the resource identifier.

modified

A string that specifies the date the resource was last modified.

name

A string that specifies the name of the resource. This is a required property.

pingcentralVersion

A string that specifies the PingCentral software version.

shouldUpdateToLatestTemplateVersion

A boolean that returns true if the application should update to the latest template version.

templateId

A string that specifies the template associated with a PingCentral application, when applicable. If a templateId is provided, the environmentId must be null.

templateVersion

A read-only integer that stores the version of the template currently being used.

type

A string that specifies the application type. Options are OAuth, OIDC, SAML_20_SP, and PINGACCESS. This is a required property.

unmanaged

A boolean that specifies whether this application is not managed by PingCentral.

usingOutdatedTemplate

A boolean that returns true if the application is not using the latest template version.

Client secret data model

Property Description

clientSecret

A string that specifies the encrypted client secret.

Application promotion history data model

Property Description

applicationId

A string that specifies the ID of a promoted PingCentral application. This is a required property, specified in the request URL.

environmentId

A string that specifies the environment ID associated with the promotion of an application. This is a required property, specified in the request URL.

environmentName

A string that specifies the name of the environment associated with the promotion of an application.

environmentShortCode

A string that specifies the short code of the environment associated with the promotion of an application.

id

A string that specifies the ID associated with the promotion of a PingCentral application.

name

A string that specifies the name of an application at the time it was promoted. This is a required property.

notPromotedInCurrentVersion

A boolean that returns true if the promotion history was created in the previous version of PingCentral.

outdatedVersion

A boolean that specifies whether a promoted application was created using an outdated version of PingCentral.

promoted

The time and date when a PingCentral application was promoted.

type

A string that specifies the type of promoted PingCentral application. Options are OAuth, OIDC, SAML_20_SP, and PINGACCESS. This is a required property.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request, or your license is exceeded.

404

The requested resource was not found.

422

The requested could not be completed because of validation error(s).