Read One Bill of Materials
GET {{apiPath}}/v1/environments/{{envId}}/billOfMaterials
The GET {{apiPath}}/v1/environments/{{envId}}/billOfMaterials endpoint returns the Bill of Materials (BOM) for the specified environment. If the environment does not have an associated BOM, which can occur with older environments, the service creates a default PingOne-related BOM and returns information showing products and services defined in the environment’s license.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/v1/environments/{{envId}}/billOfMaterials' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envId}}/billOfMaterials")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/v1/environments/{{envId}}/billOfMaterials"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Authorization", "Bearer {{accessToken}}")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
GET /v1/environments/{{envId}}/billOfMaterials HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
.url("{{apiPath}}/v1/environments/{{envId}}/billOfMaterials")
.method("GET", body)
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/v1/environments/{{envId}}/billOfMaterials",
"method": "GET",
"timeout": 0,
"headers": {
"Authorization": "Bearer {{accessToken}}"
},
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'GET',
'url': '{{apiPath}}/v1/environments/{{envId}}/billOfMaterials',
'headers': {
'Authorization': 'Bearer {{accessToken}}'
}
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
url = "{{apiPath}}/v1/environments/{{envId}}/billOfMaterials"
payload = {}
headers = {
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("GET", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v1/environments/{{envId}}/billOfMaterials');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Authorization' => 'Bearer {{accessToken}}'
));
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"
url = URI("{{apiPath}}/v1/environments/{{envId}}/billOfMaterials")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"
response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envId}}/billOfMaterials")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "GET"
let task = URLSession.shared.dataTask(with: request) { data, response, error in
guard let data = data else {
print(String(describing: error))
return
}
print(String(data: data, encoding: .utf8)!)
}
task.resume()
Example Response
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/billOfMaterials"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
}
},
"products": [
{
"id": "f25deb44-c8cc-444e-b6eb-f058d27d555c",
"type": "PING_AUTHORIZE"
},
{
"id": "2318f418-095e-4b65-8ad0-2de73cacec89",
"type": "PING_ONE_BASE"
},
{
"id": "bfb114f3-c420-4899-8f4c-b63b67a03d98",
"type": "PING_ONE_MFA",
"subtype": "CIAM",
"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/"
}
]
},
{
"id": "e7c30627-c7bc-435c-ba69-3f7aab244559",
"type": "PING_ONE_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/"
}
]
},
{
"id": "46425883-c189-45cd-b85a-9c7771671869",
"type": "PING_ONE_VERIFY"
},
{
"id": "30399679-5951-4e90-a49d-b13b9d3500a7",
"type": "PING_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/"
}
]
}
],
"createdAt": "2025-10-17T19:03:30.829Z",
"updatedAt": "2026-06-19T16:21:46.572Z"
}