The environments API endpoints support operations to create, read, update, and delete environment resources. Environments endpoints manage PingCentral environments as well as connected PingFederate and PingAccess environments.

Data model

Property Description
description A string that provides a short description of the environment.
id A string that specifies the environment associated with the resource. This field is required when updating an existing application as part of a PUT request.
idpSigningCertificate A string that specifies the identity provider’s signing certificate, which is used when promoting applications to this environment.
idpSigningCertificateName A string that specifies the identity provider’s signing certificate name, which is used when promoting applications to this environment. Maximum length is 255 characters.
idpSigningCertificatePassword A string that specifies the identity provider’s signing certificate password, which is used when promoting applications to this environment.
name A string that specifies the name of the environment resource. Maximum length is 255 characters. This is a required property.
paEnabled A boolean that specifies whether the environment is enabled for PingAccess.
paHost A string that specifies the PingAccess host name. This is a required property if paEnabled is set to true.
paPassword A string that specifies the PingAccess password. This is a required property if paEnabled is set to true.
paPort A string that specifies the PingAccess server port number. This is a required property if paEnabled is set to true.
paSkipVerification A boolean that specifies whether to bypass PingAccess version verification.
paUsername A string that specifies the PingAccess administrator username. This is a required property if paEnabled is set to true.
paVersion A string that specifies the PingAccess version number.
pfHost A string that specifies the PingFederate host name. This is a required property.
pfPassword A string that specifies the PingFederate administrator password. This is a required property.
pfPort A string that specifies the PingFederate server port number. This is a required property.
pfSkipVerification A boolean that specifies whether to bypass PingFederate version verification.
pfUsername A string that specifies the PingFederate administrator username. This is a required property.
pfVersion A string that specifies the PingFederate version number.
shielded A boolean that specifies whether services are shielded. When set to true, only administrators are allowed to promote applications to this environment.
shortCode A string that specifies short code for the PingCentral environment (for example, TEST). Maximum length is 5 characters.

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).