The following orchestration API endpoints support operations to read connection PingAccess orchestration resources.

OIDC connection orchestration

PingCentral currently only orchestrates clients, OIDC policies, and access token managers. With PingCentral, OIDC client authentication can only occur if PingFederate is correctly configured with the appropriate data sources, password credential validators, authentication policies, policy contracts, policy contract mappings, persistent grants, and access token mappings. In this version, you cannot create clients with direct adapter mappings to an IdP adapter.

SAML connection orchestration

PingCentral currently only orchestrates the PingFederate IdP connection. With PingCentral, SAML connection authentication can only occur if PingFederate is correctly configured with the appropriate data sources, password credential validators, authentication policies, and policy contracts. In this version, you cannot create connections to an IdP adapter with direct adapter mappings.

PingAccess data model details

The following sections provide a summary of the PingAccess applications, dependent resources, and site authenticators data model properties.

PingAccess application data model

Property Description
items.accessTokenValidator A string that specifies the access token validator associated with the application.
items.agent A string that specifies the agent associated with the application.
items.apiIdentityMapping A string that specifies the API identity mapping associated with the application.
items.apiRuleSets An array of strings that specifies the API rule sets associated with the application.
items.apiRules An array of strings that specifies the API rules associated with the application.
items.application A string that specifies the JSON representation of the application (for example, OrderedMap { "id": 6, "enabled": true }).
items.applicationType A string that specifies the type of application. (for example, Web).
items.contextRoot A string that specifies the application’s context root.
items.description A string that specifies the application description.
items.destination A string that specifies the application’s destination type. Options are Agent and Site.
items.enabled A boolean that specifies whether the PingAccess application is enabled.
items.id A string that specifies the ID of the PingAccess application.
items.name A string that specifies the name of the application.
items.resources A string that specifies the resources associated with the application.
items.site A string that specifies the site associated with the application.
items.virtualHosts An array of strings that specifies the virtual hosts associated with the application.
items.webIdentityMapping A string that specifies the Web identity mapping associated with the application.
items.webRulesSets An array of strings that specifies the Web rule sets associated with the application.
items.webRules An array of strings that specifies the Web rules associated with the application.
items.webSessions A string that specifies the Web session associated with the application.

PingAccess dependent resources token validator summaries data model

Property Description
accessTokenValidatorSummaries.className A string that specifies the class name associated with an access token validator.
accessTokenValidatorSummaries.configuration A string that specifies the configuration associated with an access token validator.
accessTokenValidatorSummaries.id A string that specifies the ID of the access token validator.
accessTokenValidatorSummaries.name A string that specifies the access token validator name.

PingAccess dependent resources agent summaries data model

Property Description
agentSummaries.description A string that specifies the PingAccess agent summary description.
agentSummaries.hostname A string that specifies the agent’s hostname.
agentSummaries.id A string that specifies the ID of the agent.
agentSummaries.name A string that specifies the agent’s name.
agentSummaries.port A string that specifies the agent’s port number.

PingAccess dependent resources identity mapping summaries data model

Property Description
identityMappingSummaries.className A string that specifies the class name associated with an identity mapping.
identityMappingSummaries.configuration A string that specifies the configuration associated with an identity mapping.
identityMappingSummaries.id A string that specifies the ID of the identity mapping.
identityMappingSummaries.name A string that specifies the identity mapping name.

PingAccess dependent resources site authenticator summaries data model

Property Description
siteAuthenticatorSummaries.description A string that specifies the PingAccess site authenticator summary description.
siteAuthenticatorSummaries.id A string that specifies the ID of site authenticator.
siteAuthenticatorSummaries.name A string that specifies the site authenticator’s name.

PingAccess dependent resources site summaries data model

Property Description
siteSummaries.description A string that specifies the PingAccess site summary description.
siteSummaries.id A string that specifies the ID of site.
siteSummaries.name A string that specifies the site’s name.
siteSummaries.secure A boolean that specifies whether the site is expecting HTTPS connections.
siteSummaries.siteAuthenticatorIds A list that specifies the site authenticators associated with the site.
siteSummaries.targets A list of targets for the site.

PingAccess dependent resources virtual hosts summaries data model

Property Description
virtualHostSummaries.description A string that specifies the PingAccess virtual host summary description.
virtualHostSummaries.host A string that specifies the virtual host’s hostname.
virtualHostSummaries.id A string that specifies the ID of the virtual host.
virtualHostSummaries.port A string that specifies the virtual host’s port number.

PingAccess dependent resources web sessions summaries data model

Property Description
webSessionSummaries.description A string that specifies the PingAccess web session summary description.
webSessionSummaries.audience A string that specifies the web session’s audience.
webSessionSummaries.clientCredentials A string that specifies the mapping of a web session’s client credentials.
webSessionSummaries.clientId A string that specifies the OAuth client ID associated with the web session.
webSessionSummaries.cookieDomain A string that specifies the domain associated with the PingAccess cookie.
webSessionSummaries.cookieType A string that specifies the type of PingAccess cookie for example, encrypted).
webSessionSummaries.httpOnlyCookie A boolean that specifies whether the HttpOnly flag is set on cookies that contain the PingAccess token.
webSessionSummaries.id A string that specifies the ID of the web session.
webSessionSummaries.name A string that specifies the web session name.
webSessionSummaries.oidcLoginType A string that specifies the OpenID Connect login type associated with a web session.
webSessionSummaries.sameSite A string that specifies the level of restriction for when cookies may be sent across sites.
webSessionSummaries.scopes An array of strings that specifies the list of scopes associated with a web session.
webSessionSummaries.secureCookie A boolean that specifies whether the PingAccess cookie must be sent using only HTTPS connections.
webSessionSummaries.validateSessionIsAlive A boolean that specifies whether validation of the session with PingFederate occurs.

Response codes

Code Message
200 Successful operation.
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.