PingCentral API Reference

Templates

The templates API endpoints support operations to create, read, update, and delete template resources. You can you create a PingCentral template based on an existing PingFederate or PingAcess application.

For PingAccess applications, the following property values are saved in the template:

  • Virtual host information

  • The context root

  • Application type (Web, API, or Web + API)

  • Destination type (site or agent)

  • Web session information

  • Identity mappings

  • Resource defintions

  • Rules and resource policies

For OAuth or OIDC, the following items are saved in the template:

  • Client application

  • Grant types

  • ATM, if one exists

  • Parent ATM, if one exists

  • OIDC policy, if one exists

  • Exclusive scopes referenced by the client

For SAML SP connections, the following items are saved in the template:

  • Connection information

  • Attribute names defined in the associated authentication policy contract

Data model

Property Description

created

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

description

A string that provides a description of the resource. Limited to 512 characters.

environmentId

A string that specifies the ID of the environment containing the application from which the template was created. This is a required property.

icon

A string that specifies the icon to be displayed for the PingCentral template. Possible options are apps, badge, beaker, cog, device, globe, key, or puzzle.

id

A string that specifies the ID of the PingCentral template. This field is required when updating an existing template as part of a PUT request.

modified

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

name

A string that specifies the name of the PingCentral template. Limited to 128 characters.

pingcentralVersionAtCreation

A string that specifies the version of PingCentral being used when the template was created.

revisionSummaryViews

An array list of all the revision summaries of the template.

type

A string that specifies the template type. Options are OAuth, OIDC, SAML_20_SP, and PINGACCESS.

updateTemplateComment

A string comment describing why a template has been updated.

Revision summary data model

Property Description

modified

A string that specifies the time and date when the PingCentral template was last modified.

modifiedBy

A string that specifies the author of the template revision.

revisionNumber

An integer that specifies the version number of the template revision.

updateTemplateComment

A string comment describing why a template has been updated.

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