Environments

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.

To add PingAccess environments to PingCentral, PingFederate must be configured as the token provider.

Data model

Property Description

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.
`paAuthenticationType`	A string that specifies the authentication type for the PingAccess API. Required if PingAccess is enabled. Possible values are `PASSWORD` or `OAuth2`.
`paClientId`	A string that specifies the client ID for the PingAccess API. Required if PingAccess is enabled and `paAuthenticationType` is set to `OAuth2`.
`paClientSecret`	A string that specifies the client secret for the PingAccess API. Required for adding environments if PingAccess is enabled and `paAuthenticationType` is set to `OAuth2`.
`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`.
`paScopes`	A string list of space delimited scopes for the PingAccess API. Required if PingAccess is enabled and `paAuthenticationType` is set to `OAuth2`.
`paSkipVerification`	A boolean that specifies whether to bypass PingAccess version verification.
`paTokenEndpoint`	A string that specifies the token endpoint for validating PingAccess access token. Required if PingAccess is enabled and `paAuthenticationType` is set to `OAuth2`.
`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.
`pfAuthenticationType`	A string that specifies the authentication type for the PingFederate API. Possible values are `PASSWORD` or `OAuth2`.
`pfClientId`	A string that specifies the client ID for the PingFederate API. Required if `pfAuthenticationType` is set to `OAuth2`.
`pfClientSecret`	A string that specifies the client secret for the PingFederate API. Required for adding environments if `pfAuthenticationType` is set to `OAuth2`.
`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.
`pfScopes`	A string list of space delimited scopes for the PingFederate API. Required if `pfAuthenticationType` is set to `OAuth2`.
`pfSkipVerification`	A boolean that specifies whether to bypass PingFederate version verification.
`pfTokenEndpoint`	A string that specifies the token endpoint for validating the PingFederate access token. Required if `pfAuthenticationType` is set to `OAuth2`.
`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.

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.

paAuthenticationType

A string that specifies the authentication type for the PingAccess API. Required if PingAccess is enabled. Possible values are PASSWORD or OAuth2.

paClientId

A string that specifies the client ID for the PingAccess API. Required if PingAccess is enabled and paAuthenticationType is set to OAuth2.

paClientSecret

A string that specifies the client secret for the PingAccess API. Required for adding environments if PingAccess is enabled and paAuthenticationType is set to OAuth2.

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.

paScopes

A string list of space delimited scopes for the PingAccess API. Required if PingAccess is enabled and paAuthenticationType is set to OAuth2.

paSkipVerification

A boolean that specifies whether to bypass PingAccess version verification.

paTokenEndpoint

A string that specifies the token endpoint for validating PingAccess access token. Required if PingAccess is enabled and paAuthenticationType is set to OAuth2.

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.

pfAuthenticationType

A string that specifies the authentication type for the PingFederate API. Possible values are PASSWORD or OAuth2.

pfClientId

A string that specifies the client ID for the PingFederate API. Required if pfAuthenticationType is set to OAuth2.

pfClientSecret

A string that specifies the client secret for the PingFederate API. Required for adding environments if pfAuthenticationType is set to OAuth2.

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.

pfScopes

A string list of space delimited scopes for the PingFederate API. Required if pfAuthenticationType is set to OAuth2.

pfSkipVerification

A boolean that specifies whether to bypass PingFederate version verification.

pfTokenEndpoint

A string that specifies the token endpoint for validating the PingFederate access token. Required if pfAuthenticationType is set to OAuth2.

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

PingCentral API Reference

Environments

Data model

Response codes