Update Bill of Materials

PUT {{apiPath}}/environments/{{envID}}/billOfMaterials

The PUT /environments/{{envID}}/billOfMaterials endpoint updates the Bill of Materials (BOM) for the specified environment. PingOne platform licensed features in BOM must be included in the environment's license.

Prerequisites

See Bill of Materials (BOM) for important overview information.

For property descriptions, see Bill of materials data model.

Property	Type	Required?
`console.href`	String	Optional
`deployment.id`	String	Optional
`products\[\]`	Array	Required
`products[0].description`	String	Required
`products[0].id`	String	Required
`products[0].type`	String	Required
`products[0].bookmarks\[\]`	Array	Optional
`products[0].bookmarks[0].name`	String	Optional
`products[0].bookmarks[0].href`	String	Optional
`softwareLicense.id`	String	Optional
`solutionType`	String	Optional

Request Body

{"products"=>[{"type"=>"PING_DIRECTORY", "description"=>"PingOne Directory", "bookmarks"=>[{"name"=>"PingDirectory admin documentation", "href"=>"https://docs.pingidentity.com/bundle/pingdirectory-83/page/tyt1564011416169.html"}, {"name"=>"PingDirectory API reference", "href"=>"https://apidocs.pingidentity.com/pingdirectory/directory/v1/api/guide/"}]}, {"type"=>"PING_ONE_MFA", "description"=>"PingOne MFA", "bookmarks"=>[{"name"=>"PingOne MFA admin documentation", "href"=>"https://docs.pingidentity.com/bundle/pingoneMFA/page/sur1595922082774.html"}, {"name"=>"PingOne API reference", "href"=>"https://apidocs.pingidentity.com/pingone/platform/v1/api/"}]}, {"type"=>"PING_ONE_PROVISIONING", "description"=>"PingOne Provisioning"}, {"type"=>"PING_ONE_RISK", "description"=>"PingOne Risk", "bookmarks"=>[{"name"=>"PingOne Risk admin documentation", "href"=>"https://docs.pingidentity.com/bundle/pingoneRisk/page/ytr1603474916048.html"}, {"name"=>"PingOne API reference", "href"=>"https://apidocs.pingidentity.com/pingone/platform/v1/api/"}]}]}

RESPONSES

status: OK

{&quot;_links&quot;:{&quot;self&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/billOfMaterials&quot;},&quot;environment&quot;:{&quot;href&quot;:&quot;https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6&quot;}},&quot;products&quot;:[{&quot;id&quot;:&quot;fdcd9ccc-d05d-4229-a33c-5ae2a2f08039&quot;,&quot;type&quot;:&quot;PING_DIRECTORY&quot;,&quot;description&quot;:&quot;PingOne Directory&quot;,&quot;bookmarks&quot;:[{&quot;name&quot;:&quot;PingDirectory admin documentation&quot;,&quot;href&quot;:&quot;https://docs.pingidentity.com/bundle/pingdirectory-83/page/tyt1564011416169.html&quot;},{&quot;name&quot;:&quot;PingDirectory API reference&quot;,&quot;href&quot;:&quot;https://apidocs.pingidentity.com/pingdirectory/directory/v1/api/guide/&quot;}]},{&quot;id&quot;:&quot;39b8a197-50b2-4979-bf23-7cf0f00fd6d4&quot;,&quot;type&quot;:&quot;PING_ONE_MFA&quot;,&quot;description&quot;:&quot;PingOne MFA&quot;,&quot;bookmarks&quot;:[{&quot;name&quot;:&quot;PingOne MFA admin documentation&quot;,&quot;href&quot;:&quot;https://docs.pingidentity.com/bundle/pingoneMFA/page/sur1595922082774.html&quot;},{&quot;name&quot;:&quot;PingOne API reference&quot;,&quot;href&quot;:&quot;https://apidocs.pingidentity.com/pingone/platform/v1/api/&quot;}]},{&quot;id&quot;:&quot;a5c08bde-bfb9-48c4-bcb9-3eef991692eb&quot;,&quot;type&quot;:&quot;PING_ONE_PROVISIONING&quot;,&quot;description&quot;:&quot;PingOne Provisioning&quot;},{&quot;id&quot;:&quot;db9033eb-7efa-4be5-8952-e0937908398a&quot;,&quot;type&quot;:&quot;PING_ONE_RISK&quot;,&quot;description&quot;:&quot;PingOne Risk&quot;,&quot;bookmarks&quot;:[{&quot;name&quot;:&quot;PingOne Risk admin documentation&quot;,&quot;href&quot;:&quot;https://docs.pingidentity.com/bundle/pingoneRisk/page/ytr1603474916048.html&quot;},{&quot;name&quot;:&quot;PingOne API reference&quot;,&quot;href&quot;:&quot;https://apidocs.pingidentity.com/pingone/platform/v1/api/&quot;}]}],&quot;createdAt&quot;:&quot;2021-04-08T21:09:15.856Z&quot;,&quot;updatedAt&quot;:&quot;2021-08-25T21:14:42.944Z&quot;}