--- title: Bill of Materials (BOM) description: 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. component: pingone-api page_id: pingone-api:platform:bill-of-materials-bom canonical_url: https://developer.pingidentity.com/pingone-api/platform/bill-of-materials-bom.html section_ids: assigning-admin-roles-and-permissions-to-this-service: Assigning admin roles and permissions to this service bill-of-materials-data-model: Bill of Materials data model products-data-model: Products data model bill-of-materials-events-generated: Bill of Materials events generated response-codes: Response codes --- # Bill of Materials (BOM) 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, refer to [Roles](roles.html). ## Assigning admin roles and permissions to this service Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to [PingOne Permissions by Service](reference/roles-and-permissions-in-pingone/permissions-by-service.html) for the service-specific permissions. You can also choose to assign admin roles based on particular service resources. Refer to [PingOne Permissions by Resource](reference/roles-and-permissions-in-pingone/permissions-by-resource.html) when assigning admin roles per service resources. Admin assignments to roles are set by: * [Automatic assignment for some roles](roles/predefined-roles.html#automatic-role-assignment). * [Group Role Assignments](group-role-assignments/group-role-assignments.html). * [User Role Assignments](users/user-role-assignments.html). Refer to [Roles Management](roles.html) for more information. ## Bill of Materials data model | Property | Type | Required? | Mutable? | Description | | -------------- | --------- | --------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `_links` | Object | N/A | Read-only | HAL links. | | `_links.href` | String | N/A | Read-only | HAL link. | | `_embedded` | Object | N/A | Read-only | HAL embedded resources. | | `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. | | `products` | Array | Required | Immutable | The products that comprise the environment. | | `createdAt` | Date Time | N/A | Read-only | Date and time the resource was created. | | `updatedAt` | Date Time | N/A | Read-only | Date and time the resource was last updated. | ## Products data model | Property | Type | Required? | Mutable? | Description | | -------------------- | --------- | --------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | String | Required | Immutable | The ID of the product. Ignored on PUT operations. | | `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`, `PING_ONE_ID` (v2 customers), 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` (v1 customers), `PING_ID_SDK`, `PING_CENTRAL`, `PING_INTELLIGENCE`, `PING_ONE_FOR_SAAS`, and `PING_AUTHORIZE`. | | `description` | String | Optional | Mutable | Description of the product or standalone service. | | `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. | | `softwareLicense` | Object | Optional | Immutable | The Ping software license associated with this product. | | `softwareLicense.id` | String | Optional | Immutable | The UUID of the Ping software license associated with this product. This is not the SFDC external ID. | | `deployment` | Object | Optional | Immutable | The external resource associated with this product, containing state and settings related to the external resource. | | `deployment.id` | String | Optional | Immutable | The ID of the external resource associated with this product. | | `bookmarks` | String\[] | Optional | Mutable | Custom bookmarks. Maximum of five bookmarks per product. | | `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. | | `bookmarks.href` | String | Optional | Mutable | A valid URL for the bookmark. | | `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. | | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | The other Ping Identity products identified in the `products.type` property are not hosted on the PingOne platform. These products are not subject to any licensing restrictions when they are added or removed from the BOM. Conversely, PingOne platform products are hosted on the platform and are subject to licensing restrictions when they are added to the BOM. | ## Bill of Materials events generated Refer to [Audit Reporting Events](reference/audit-reporting-events.html) for the events generated. ## 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. | | 404 | The requested resource was not found. | | 500 | Internal server error. |