PingOne environments serve as the container for the products and services that are licensed for a specific customer deployment. The Bill of Materials (BOM) service references the products and standalone shared services associated with an environment, functioning like a product registry for the environment. You can optionally add up to five custom bookmarks for each product in the BOM. Users will be able to access these bookmarks from the PingOne dashboard.
The Bill of Materials service is closely associated with the Environments and Licensing services. A PingOne environment contains the configuration options for a deployment, which can include any (or all) Ping Identity products. PingOne supports multiple environments, and each environment can have its own deployment configuration. You can use the Bill of Materials (BOM) service to retrieve a specified environment’s BOM to show product details in the environment’s current configuration. The service also includes a supported action to update the BOM with additional licensed PingOne products (or non-PingOne Ping Identity products) to fine-tune the environment’s deployment capabilities.
You need the Environment Admin role to get the Bill Of Materials for an environment. For more information about roles, see Roles.
To see the effects of these events for an API call, see the event types in the Audit Report, Audit Activities API, or Webhook stream.
The audit reporting events applicable to the BOM service history are:
Service | Event |
---|---|
environments |
ENVIRONMENT.CREATED |
environments |
ENVIRONMENT.UPDATED |
environments |
ENVIRONMENT.UPDATED |
Property | Type | Required? | Mutable? | Description |
---|---|---|---|---|
console.href |
String | Optional | Mutable | Link to your administrative console for the product, whether the product is in the PingOne platform, PingCloud, a private cloud, or on-premises. If specified, must be an RFC 2396-compliant URI with a maximum length of 1024 characters. |
createdAt |
Date | N/A | Read-only | The time the resource was created. |
deployment.id |
String | Optional | Immutable | The ID of the external resource associated with this product, containing state and settings related to the external resource. |
products |
Array | Required | Immutable | The products that comprise the environment. |
products.description |
String[] | Required | Immutable | Description of the product or standalone service. |
products.id |
String[] | Required | Immutable | The BOM ID of the product or standalone service. |
products.type |
String[] | Required | Immutable | The Ping Identity product type. Options for PingOne platform products are PING_ONE_MFA , PING_ONE_RISK (this name also represents the PingOne Protect product), PING_ONE_DAVINCI , PING_ONE_VERIFY , PING_ONE_CREDENTIALS , PING_ONE_AUTHORIZE , PING_ONE_PROVISIONING , and PING_ONE_BASE . The PING_ONE_BASE product represents the default set of services that an environment can use on the PingOne platform. Options for other Ping Identity products are PING_FEDERATE , PING_ACCESS , PING_DIRECTORY , PING_DATA_SYNC , PING_DATA_GOVERNANCE , PING_ONE_FOR_ENTERPRISE , PING_ID , PING_ID_SDK , PING_CENTRAL , PING_INTELLIGENCE , PING_ONE_FOR_SAAS , and PING_AUTHORIZE . |
products.bookmarks |
String[] | Optional | Mutable | Custom bookmarks. Maximum of five bookmarks per product. |
products.bookmarks.name |
String[] | Optional | Mutable | Name of the custom bookmark. The name must be unique among the product bookmarks and be 50 characters or fewer. |
products.bookmarks.href |
String[] | Optional | Mutable | A valid URL for the bookmark. |
softwareLicense.id |
String | Optional | Immutable | The software license associated with this product. This is the Ping UUID, not the SFDC external ID. |
solutionType |
String | Optional | Immutable | The solution type selected when creating the environment. Ignored on PUT operations. The following values are supported: CIAM_TRIAL. The Customer trial experience. Indicates the Customer solution type, and the Solution Designer was selected. WF_TRIAL. The Workforce trial experience. Indicates the Workforce solution type, and the Solution Designer was selected. CUSTOMER. Indicates the Customer solution type was selected. This solution type uses PingOne MFA, rather than PingID. WORKFORCE. Indicates the Workforce solution type was selected. This solution type uses PingID, rather than PingOne MFA. |
tags |
String[] | Optional | Mutable | The set of tags for the PingOne products to be initially configured. The currently supported value is “DAVINCI_MINIMAL” (only valid when the product type is PING_ONE_DAVINCI). This indicates that DaVinci is to be configured with a minimal set of resources. |
updatedAt |
Date | N/A | Read-only | The time the resource was last updated. |
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. |
404 | The requested resource was not found. |
500 | Internal server error. |