getSaasBomItems

Retrieves a paginated list of SaaS BOM items for the organization with comprehensive filtering options. Useful for displaying and managing the software inventory of SaaS applications.

Examples

GraphQL

query GetSaasBomItems($getSaasBomItemsInput: GetSaasBomItemsInput) {
  getSaasBomItems(getSaasBomItemsInput: $getSaasBomItemsInput) {
    saasBomItems {
      id
      appId
      appName
      appType
      name
      link
      category
      createdAt
      extraInfo {
        key
        link
        snippet {
          detectionType
          fileName
          snippetLineNumber
          language
          text
        }
      }
      issuesBySeverity {
        info
        low
        medium
        high
        critical
        appox
      }
    }
    total
    totalFiltered
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "getSaasBomItemsInput": {
    "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
    "offset": 0,
    "limit": 100,
    "owners": ["example"],
    "tagIds": ["example"],
    "filters": {
      "apps": ["example"],
      "categories": ["example"],
      "name": ["SomeName"],
      "reachability": ["example"],
      "detectionType": ["example"]
    },
    "filterSearch": [
      {
        "fieldName": "example",
        "value": ["example"]
      }
    ],
    "openItems": ["digest"],
    "orderBy": {
      "field": "example",
      "direction": "ASC"
    },
    "search": "example"
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetSaasBomItems($getSaasBomItemsInput: GetSaasBomItemsInput) { getSaasBomItems(getSaasBomItemsInput: $getSaasBomItemsInput) { saasBomItems { id appId appName appType name link category createdAt extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } issuesBySeverity { info low medium high critical appox } } total totalFiltered } }",
 "variables": {
    "getSaasBomItemsInput": {
      "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
      "offset": 0,
      "limit": 100,
      "owners": ["example"],
      "tagIds": ["example"],
      "filters": {
        "apps": ["example"],
        "categories": ["example"],
        "name": ["SomeName"],
        "reachability": ["example"],
        "detectionType": ["example"]
      },
      "filterSearch": [
        {
          "fieldName": "example",
          "value": ["example"]
        }
      ],
      "openItems": ["digest"],
      "orderBy": {
        "field": "example",
        "direction": "ASC"
      },
      "search": "example"
    }
  }
}'

Node.js

const query = 'query GetSaasBomItems($getSaasBomItemsInput: GetSaasBomItemsInput) { getSaasBomItems(getSaasBomItemsInput: $getSaasBomItemsInput) { saasBomItems { id appId appName appType name link category createdAt extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } issuesBySeverity { info low medium high critical appox } } total totalFiltered } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      getSaasBomItemsInput: {
        scanId: "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        offset: 0,
        limit: 100,
        owners: ["example"],
        tagIds: ["example"],
        filters: {
          apps: ["example"],
          categories: ["example"],
          name: ["SomeName"],
          reachability: ["example"],
          detectionType: ["example"]
        },
        filterSearch: [
          {
            fieldName: "example",
            value: ["example"]
          }
        ],
        openItems: ["digest"],
        orderBy: {
          field: "example",
          direction: "ASC"
        },
        search: "example"
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetSaasBomItems($getSaasBomItemsInput: GetSaasBomItemsInput) { getSaasBomItems(getSaasBomItemsInput: $getSaasBomItemsInput) { saasBomItems { id appId appName appType name link category createdAt extraInfo { key link snippet { detectionType fileName snippetLineNumber language text } } issuesBySeverity { info low medium high critical appox } } total totalFiltered } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "getSaasBomItemsInput": {
        "scanId": "c9da693d-8906-4a32-93c9-2ffdb1cebb99",
        "offset": 0,
        "limit": 100,
        "owners": ["example"],
        "tagIds": ["example"],
        "filters": {
          "apps": ["example"],
          "categories": ["example"],
          "name": ["SomeName"],
          "reachability": ["example"],
          "detectionType": ["example"]
        },
        "filterSearch": [
          {
            "fieldName": "example",
            "value": ["example"]
          }
        ],
        "openItems": ["digest"],
        "orderBy": {
          "field": "example",
          "direction": "ASC"
        },
        "search": "example"
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your getSaasBomItems query.

Argument	Description	Supported fields
getSaasBomItemsInput GetSaasBomItemsInput	Input parameters for filtering, sorting, and paginating SaaS BOM items	scanId String offset Int limit Int owners [String] tagIds [String] filters SaasBomFilters filterSearch [AutoCompleteSearch] openItems [FilterTypes] orderBy SaasBomOrderBy search String

Fields

Return type: SaasBomItemsResponse

You can use the following field(s) to specify what information your getSaasBomItems query will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
saasBomItems [SaasBomItem]	List of SaaS BOM items matching the query criteria	id String appId String appName String appType String name String link String category String createdAt Date extraInfo [ApplicationExtraInfo] issuesBySeverity Severities
total Int	Total number of items in the system
totalFiltered Int	Number of items matching the current filter criteria