Supported Tokens and Operators for v2 APIs

This topic provides an overview of the supported tokens and the operators that can be used with those tokens across CSAM v2 APIs.

Supported Operators

The following dropdown provides the list of operators:

List of operatorsList of operators

Supported Tokens by API Category

This section lists the tokens that support operators, grouped by the API.

Asset Host Data APIs

The complete list of tokens and their supported operators for the Asset Host Data APIs is listed in the drop-down below.

These tokens are supported for:

• Count of Assets
• Get Host Details of All Assets
• Get Host Details of Specific Asset

List of tokens with supported operatorsList of tokens with supported operators

Vulnerability APIs

The complete list of tokens and their supported operators for the Vulnerability APIs is listed in the drop-downs below.

These tokens are supported for:

• GET List of Vulnerabilities Discovered by EASM

  List of tokens with supported operatorsList of tokens with supported operators

  Token	Supported Operators
  asset.Id	NUMERIC_OPERATORS
  asset.ipaddress	IP_OPERATORS
  vulnerabilities.vulnerability.cveId	STRING_OPERATORS
  vulnerabilities.typeDetected	STRING_OPERATORS
  vulnerability.cvss	STRING_OPERATORS
  vulnerability.qvs	STRING_OPERATORS

• GET List of Vulnerabilities discovered by EASM Scan

  List of tokens with supported operatorsList of tokens with supported operators

   

  Token	Supported Operators
  vulnerabilities.isDisabled	STRING_OPERATORS
  vulnerabilities.ssl	STRING_OPERATORS
  vulnerabilities.qid	STRING_OPERATORS
  vulnerabilities.status	STRING_OPERATORS
  vulnerabilities.id	STRING_OPERATORS
  vulnerabilities.port	STRING_OPERATORS
  vulnerabilities.firstFoundDate	STRING_OPERATORS
  vulnerabilities.rti	STRING_OPERATORS
  asset.Id	NUMERIC_OPERATORS
  vulnerabilities.isIgnored	BOOLEAN_OPERATORS
  vulnerabilities.lastFoundDate	DATE_OPERATORS
  vulnerabilities.lastScanned	BOOLEAN_OPERATORS
  vulnerabilities.severity	STRING_OPERATORS
  vulnerabilities.protocol	STRING_OPERATORS
  vulnerabilities.updatedDate	DATE_OPERATORS
  vulnerabilities.solution	STRING_OPERATORS
  vulnerabilities.isFound	BOOLEAN_OPERATORS
  vulnerabilities.patchReleaseDate	DATE_OPERATORS
  vulnerabilities.title	STRING_OPERATORS

EASM Organization and Subsidiary APIs

The complete list of tokens and their supported operators for the EASM Organization or Subsidiary APIs is listed in the drop-down below.

These tokens are supported for:

• Get Organization or Subsidiaries Count API
• Get Organization or Subsidiaries List API

List of tokens with supported operatorsList of tokens with supported operators

Domain APIs

The complete list of tokens and their supported operators for the Domain APIs is listed in the drop-down below.

These tokens are supported for:

• Get a List of Unresolved Domains
• Get the Count of Unresolved Domains

List of tokens with supported operatorsList of tokens with supported operators

Important to Know!

The following tokens are available only for CSAM License Subscriber:

hardware.lifecycle.stage, hardware.lifecycle.eos, hardware.lifecycle.ga, hardware.lifecycle.intro, hardware.lifecycle.obs, software.authorization, software.license.category, software.license.subcategory, software.lifecycle.eol, software.lifecycle.eos, software.lifecycle.ga, software.lifecycle.stage, software.isPackage, software.isPackageComponent, operatingSystem.lifecycle.eol, operatingSystem.lifecycle.eos, operatingSystem.lifecycle.ga, operatingSystem.lifecycle.stage, customAttributes.key, customAttributes.value, and customAttributes.connectorId.

Examples to Understand Supported operators by comparing QQL Tokens

The following are some examples to understand the different supported operators by comparing QQL(UI) tokens:

Example 1 - hardware.category1:ComputersExample 1 - hardware.category1:Computers

<FilterRequest>
    <filters>
        <Criteria field="hardware.category1" operator="CONTAINS">
            <value>Computers</value>
        </Criteria>
    </filters>
</FilterRequest>      
    

{
   "filters":[
      {
         "field":"hardware.category1",
         "operator":"CONTAINS",
         "value":"Computers"
      }
   ]
}      
    

Example 2 - hardware.manufacturer:`Apple` OR hardware.manufacturer:`HPE`Example 2 - hardware.manufacturer:`Apple` OR hardware.manufacturer:`HPE`

<FilterRequest>
    <filters>
        <Criteria field="hardware.manufacturer" operator="IN">
            <value>Apple,HPE</value>
        </Criteria>
    </filters>
</FilterRequest>
    

Example 3 - software:(product:Python and update:2.7.5)Example 3 - software:(product:Python and update:2.7.5)

<FilterRequest>
    <filters>
        <Criteria field="software.product" operator="CONTAINS">
            <value>Python</value>
        </Criteria>
        <Criteria field="software.update" operator="CONTAINS">
            <value>2.7.5</value>
        </Criteria>
    </filters>
</FilterRequest>      
    

Example 4 - operatingSystem.category1:`Mac` and hardware.category:NotebookExample 4 - operatingSystem.category1:`Mac` and hardware.category:Notebook

<FilterRequest>
    <filters>
        <Criteria field="operatingSystem.category1" operator="EQUALS">
            <value>Mac</value>
        </Criteria>
        <Criteria field="hardware.category" operator="EQUALS">
            <value>Notebook</value>
        </Criteria>
    </filters>
</FilterRequest>      
    

Example 5 - operatingSystem.category1:`Mac` or hardware.category:NotebookExample 5 - operatingSystem.category1:`Mac` or hardware.category:Notebook

<FilterRequest>
    <filters>
        <Criteria field="operatingSystem.category1" operator="EQUALS">
            <value>Mac</value>
        </Criteria>
        <Criteria field="hardware.category" operator="EQUALS">
            <value>Notebook</value>
        </Criteria>
    </filters>
    <operation>OR</operation>
</FilterRequest>      
    

{
   "filters":[
      {
         "field":"operatingSystem.category1",
         "operator":"EQUALS",
         "value":"Mac"
      },
      {
         "field":"hardware.category",
         "operator":"EQUALS",
         "value":"Notebook"
      }
   ],
   "operation":"OR"
}      
    

Example 6 - operatingSystem.category1:`Mac` and hardware.category:NotebookExample 6 - operatingSystem.category1:`Mac` and hardware.category:Notebook

<FilterRequest>
    <filters>
        <Criteria field="operatingSystem.category1" operator="EQUALS">
            <value>Mac</value>
        </Criteria>
        <Criteria field="hardware.category" operator="EQUALS">
            <value>Notebook</value>
        </Criteria>
    </filters>
    <operation>AND</operation>
</FilterRequest>