Skip to main content

Orca

Orca is a cloud security tool that enhances visibility across your cloud environments. You can bring cloud, container, database, function, package, storage, user, virtual machine, and security data from Orca into Brinqa to gain a unified view of your cloud-related attack surface, thus enhancing your cybersecurity posture.

This document details the information you must provide for the connector to authenticate with Orca and how to obtain that information from Orca. See create a data integration for step-by-step instructions on setting up the integration.

Required connection settings

When setting up a data integration, select Orca from the Connector drop-down. If you cannot find the connector in the drop-down, make sure that you have installed it first. You must provide the following information to authenticate Orca with Brinqa:

  • API URL: The Orca API Server URL: The default URL is https://api.orcasecurity.io.

    • The API URL depends on the region of your Orca environment. For additional information, see Orca documentation.
  • API Token: The API token associated with the Orca account, which must have permissions to log in to the API server and return data.

Generate an Orca API token

For the Orca connector to use the Orca API, you must provide an API token. To generate an API token, follow these steps:

  1. Log in to your organization's Orca account as an administrator

  2. Click Settings from the navigation menu.

  3. Navigate to Users & Permissions > API.

  4. Click API Tokens, and then click Add API Token. The Create API Token dialog displays.

    Provide the following information:

    • Name: Give your API token a name.

    • Description: Provide a description of the API token.

    • Never Expire: Marked by default. The Expiration field appears if you clear the checkbox. You can then select the token expiry date if desired.

    • Service Token: Service tokens operate independently of individual user accounts, inheriting their permissions based on the creator's permissions. Service tokens remain valid even if the creator's account is deactivated or removed from the organization. If desired, select this option to enable the use of a service token.

    • Role: Define the permissions of the token. While the Administrator role can bring in all data, Brinqa recommends that you use the Viewer role, as this is considered to be the minimum role needed to read and retrieve data.

    • Scope: Select the specific accounts or business units that the API token will be authorized to access. Leave this option unchecked if you do not want to limit the data retrieved by the Orca connector.

  5. Click Add.

    Your API Token displays. Save the token to a secure location. You can not view the token again.

  6. Click Continue.

note

If you do not have the permissions to create an API token, contact your Orca administrator. For additional information, see Orca documentation.

Additional settings

The Orca connector contains additional options for specific configuration:

  • Page size: The maximum number of records to get per API request. The default setting is 1000. It is not recommended to go over 1000.

  • Parallel requests: The maximum number of parallel API requests. The default setting is 8.

  • Request timeout (secs): The maximum time allotted, in seconds, before a request times out. The default setting is 120 seconds. Although it is not recommended, you can also enter zero (0) to disable timeouts.

  • Maximum retries: The maximum number of times that the integration attempts to connect to the Orca API before giving up and reporting a failure. The default setting is 5.

Types of data to retrieve

The Orca connector can retrieve the following types of data from Orca:

Table 1: Data retrieved from Orca

Connector ObjectRequiredMaps to Data Model
AlertNoAlert
Alert DefinitionNoAlert Definition
Cloud AccountYesCloud Account
ContainerYesContainer
Container ImageYesContainer Image
DatabaseNoCloud Resource
FunctionYesCloud Resource
Installed PackageNoInstalled Package
PackageNoPackage
StorageNoCloud Resource
UserNoCloud Resource
Virtual MachineYesHost
Virtual Machine ImageYesHost Image
VulnerabilityNoVulnerability
Vulnerability DefinitionNoVulnerability Definition
Vulnerability PackageNoNot mapped
info

For detailed steps on how to view the data retrieved from Orca in the Brinqa Platform, see How to view your data.

Attribute mappings

Expand the sections below to view the mappings between the source and the Brinqa data model attributes.

Alert

Table 2: Alert attribute mappings

Source Field NameMaps to Attribute
ALERT_LABELStags
ASSET_NAMELocal variable
ASSET_SYS_IDLocal variable
ASSET_TYPELocal variable
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMEcloudAccountName
CLOUD_ACCOUNT_TYPEcloudAccountType
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDcloudProviderId
CLOUD_VENDOR_IDcloudVendorId
CREATION_TIMEsourceCreatedDate
IN_VERIFICATIONLocal variable
LAST_FOUNDlastFound
ORCA_SCORELocal variable
RULE_IDtype
SCORELocal variable
SOURCELocal variable
STATUSstatus(normalized), sourceStatus, statusCategory
STATUS_TIMELocal variable
SUBJECT_TYPELocal variable
SYS_IDuid
TARGETStargets
UPDATED_TIMEsourceLastModified
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Alert Definition

Table 3: Alert Definition attribute mappings

Source Field NameMaps to Attribute
ALERT_LABELStags
CATEGORYcategories
CREATED_ATsourceCreatedDate
CVE_LISTcveRecords
DETAILSsummary
IS_COMPLIANCELocal variable
IS_RULELocal variable
LAST_SEENlastFound
LAST_UPDATEDsourceLastModified
MITRE_CATEGORYLocal variable
MITRE_TECHNIQUELocal variable
ORCA_SCORELocal variable
RECOMMENDATIONSrecommendation
RISK_LEVELLocal variable
RULE_QUERYLocal variable
RULE_SOURCELocal variable
SCORELocal variable
SEVERITYseverity
SEVERITY_CONTRIBUTING_FACTORSLocal variable
SEVERITY_REDUCING_FACTORSLocal variable
SEVERITY_SCORELocal variable
SOURCE_SEVERITYLocal variable
STATUSstatus, sourceStatus
SYS_IDuid
TARGETStargets
TYPE, TYPE_STRINGname
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Cloud Account

Table 4: Cloud Account attribute mappings

Source Field NameMaps to Attribute
ACCOUNT_TYPELocal variable
AUTO_REMEDIATION_ENABLEDLocal variable
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
NAMEname
SYS_IDuid
TAGStags
VENDOR_IDLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Container

Table 5: Container attribute mappings

Source Field NameMaps to Attribute
APPLICATIONSLocal variable
ASSET_TYPEtype
AUTO_UPDATES_STATUSLocal variable
AVAILABILITY_ZONESLocal variable
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CPU_COUNTLocal variable
CPU_FREQUENCYLocal variable
CPU_TYPELocal variable
CREATION_TIMEsourceCreatedDate
DESCRIPTIONdescription
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
DISTRIBUTION_CATEGORYLocal variable
DISTRIBUTION_MAJOR_VERSIONLocal variable
DISTRIBUTION_NAMELocal variable
DISTRIBUTION_VERSIONLocal variable
ESM_STATUSLocal variable
EXEC_NAMELocal variable
EXEC_PATHLocal variable
EXPOSURELocal variable
HAS_PIILocal variable
HOST_NAMEhostnames
IDLocal variable
IMAGE_DIGESTLocal variable
IMAGE_IDimage
IMAGE_LAYERS_DIGESTLocal variable
IMAGE_NAMELocal variable
IMAGE_VERSIONLocal variable
IS_INTERNET_FACINGLocal variable
K8S_CONTAINER_NAMELocal variable
K8S_POD_NAMESLocal variable
K8S_POD_NAMESPACELocal variable
LABELSLocal variable
MAC_ADDRESSESmacAddresses
MAINTAINERLocal variable
MEMORY_SIZELocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
OS_BIT_MODELocal variable
OS_END_OF_SUPPORTLocal variable
OS_SUPPORT_INFO_SITELocal variable
OWNERowner
PII_TYPESLocal variable
PRIVATE_DNSSprivateDnsNames
PRIVATE_IPSprivateIpAddresses
PUBLIC_DNSSpublicDnsNames
PUBLIC_IPSpublicIpAddresses
REGIONSLocal variable
REGION_NAMESLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SECURITY_GROUPSLocal variable
SERVICE_NAMELocal variable
STATELocal variable
STOP_DATELocal variable
STORAGE_DRIVERLocal variable
SUBCATEGORYLocal variable
SUBNETSLocal variable
SYS_IDuid
TAGStags
TOTAL_DISK_BYTESLocal variable
UP_TIMELocal variable
UP_TIME_HOURSLocal variable
USERLocal variable
VIRTUAL_CPU_COUNTLocal variable
VM_IDhost, Local variable
VM_SYS_IDLocal variable
VPCSLocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Container Image

Table 6: Container Image attribute mappings

Source Field NameMaps to Attribute
APPLICATIONSLocal variable
ASSET_TYPEtype
AUTO_UPDATES_STATUSLocal variable
AVAILABILITY_ZONESLocal variable
CATEGORYcategories
CPU_COUNTLocal variable
CPU_FREQUENCYLocal variable
CPU_TYPELocal variable
CREATION_TIMEsourceCreatedDate
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
DISTRIBUTION_CATEGORYLocal variable
DISTRIBUTION_MAJOR_VERSIONLocal variable
DISTRIBUTION_NAMELocal variable
DISTRIBUTION_VERSIONLocal variable
ESM_STATUSLocal variable
EXPOSURELocal variable
HOST_NAMEhostname
IMAGE_DESCRIPTIONLocal variable
IMAGE_DIGESTdigest
IMAGE_IDimage
IMAGE_LABELSLocal variable
IMAGE_LAYERS_DIGESTLocal variable
IMAGE_NAMELocal variable
IMAGE_PUSHED_ATLocal variable
IMAGE_SIZELocal variable
IMAGE_TAGSLocal variable
MAC_ADDRESSESmacAddresses
MEMORY_SIZELocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
OWNERowner
PRIVATE_DNSSprivateDnsNames
PRIVATE_IPSprivateIpAddresses
PUBLIC_DNSSpublicDnsNames
PUBLIC_IPSpublicIpAddresses
REGIONSLocal variable
REGION_NAMESLocal variable
REPOSITORY_NAMErepository
REPOSITORY_URILocal variable
SECURITY_GROUPSLocal variable
STATELocal variable
STOP_DATELocal variable
SUBNETSLocal variable
SYS_IDuid
TAGStags
TOTAL_DISK_BYTESLocal variable
UP_TIMELocal variable
UP_TIME_HOURSLocal variable
UPDATED_TIMEsourceLastModified
VIRTUAL_CPU_COUNTLocal variable
VPCSLocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Database

Table 7: Database attribute mappings

Source Field NameMaps to Attribute
ASSET_TYPEtype
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CREATION_TIMEsourceCreatedDate
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
EXPOSURELocal variable
IS_INTERNET_FACINGLocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SUBCATEGORYLocal variable
SYS_IDuid
TAGStags
UPDATED_TIMEsourceLastModified
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Function

Table 8: Function attribute mappings

Source Field NameMaps to Attribute
APPLICATIONSLocal variable
ASSET_TYPEtype
AUTO_UPDATES_STATUSLocal variable
AVAILABILITY_ZONESLocal variable
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CPU_COUNTLocal variable
CPU_FREQUENCYLocal variable
CPU_TYPELocal variable
CREATION_TIMEsourceCreatedDate
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
DISTRIBUTION_CATEGORYLocal variable
DISTRIBUTION_MAJOR_VERSIONLocal variable
DISTRIBUTION_NAMELocal variable
DISTRIBUTION_VERSIONLocal variable
ESM_STATUSLocal variable
EXPOSURELocal variable
FUNCTION_IDLocal variable
FUNCTION_NAMELocal variable
HAS_PIILocal variable
HOST_NAMEhostname
IS_INTERNET_FACINGLocal variable
MAC_ADDRESSESmacAddresses
MEMORY_SIZELocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
OS_BIT_MODELocal variable
OS_END_OF_SUPPORTLocal variable
OS_SUPPORT_INFO_SITELocal variable
OWNERowner
PII_TYPESLocal variable
PRIVATE_DNSSprivateDnsNames
PRIVATE_IPSprivateIpAddresses
PUBLIC_DNSSpublicDnsNames
PUBLIC_IPSpublicIpAddresses
REGIONSLocal variable
REGION_NAMESLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SECURITY_GROUPSLocal variable
STATELocal variable
STOP_DATELocal variable
SUBCATEGORYLocal variable
SUBNETSLocal variable
SYS_IDuid
TAGStags
TOTAL_DISK_BYTESLocal variable
UP_TIMELocal variable
UP_TIME_HOURSLocal variable
UPDATED_TIMEsourceLastModified
VIRTUAL_CPU_COUNTLocal variable
VPCSLocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Installed Package

Table 9: Installed Package attribute mappings

Source Field NameMaps to Attribute
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
installedPackage.content.getAssetUniqueIdtargets
installedPackage.iduid
installedPackage.installDateinstalledDate
installedPackage.isInstalledByPackageManagerLocal variable
installedPackage.namename
installedPackage.nonOsPackagePathsLocal variable
installedPackage.packagetype
installedPackage,versionrevision
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Package

Table 10: Package attribute mappings

Source Field NameMaps to Attribute
ARCHITECTURELocal variable
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
DESCRIPTIONdescription
EDITIONLocal variable
EOL_DATELocal variable
IS_LATESTLocal variable
IS_OS_PACKAGELocal variable
LATEST_AVAILABLE_VERSIONlatestVersion
LINKurl
NAMEname
PUBLISHERpublisher
RELEASE_DATELocal variable
SYS_IDuid
VERSIONcurrentVersion
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Storage

Table 11: Storage attribute mappings

Source Field NameMaps to Attribute
ASSET_TYPEtype
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CREATION_TIMEsourceCreatedDate
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
EXPOSURELocal variable
HAS_PIILocal variable
IS_INTERNET_FACINGLocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
PII_TYPESLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SUBCATEGORYLocal variable
SYS_IDuid
TAGStags
TOTAL_FILES_COUNTLocal variable
UPDATED_TIMEsourceLastModified
USED_STORAGELocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

User

Table 12: User attribute mappings

Source Field NameMaps to Attribute
ASSET_TYPEtype
CATEGORYcategories
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CREATION_TIMEsourceCreatedDate
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
EXPOSURELocal variable
IS_INTERNET_FACINGLocal variable
MFA_ACTIVELocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
PASSWORD_ENABLEDLocal variable
PASSWORD_LAST_CHANGEDLocal variable
PASSWORD_LAST_USEDLocal variable
PASSWORD_NEXT_ROTATIONLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SUBCATEGORYLocal variable
SYS_IDuid
TAGStags
UPDATED_TIMEsourceLastModified
USERNAMEuserName
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Virtual Machine

Table 13: Virtual Machine attribute mappings

Source Field NameMaps to Attribute
APPLICATIONSLocal variable
ASSET_TYPEtype
AUTO_UPDATES_STATUSLocal variable
AVAILABILITY_ZONESLocal variable
CATEGORYcategories
CPU_COUNTLocal variable
CPU_FREQUENCYLocal variable
CPU_TYPELocal variable
CREATION_TIMEsourceCreatedDate
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
DISTRIBUTION_CATEGORYLocal variable
DISTRIBUTION_MAJOR_VERSIONLocal variable
DISTRIBUTION_NAMELocal variable
DISTRIBUTION_VERSIONLocal variable
ESM_STATUSLocal variable
EXPOSURELocal variable
HAS_PIILocal variable
HOST_NAMEhostnames
IMAGE_IDimage
IMAGE_NAMELocal variable
IMAGE_OWNER_IDLocal variable
INSTANCE_TYPELocal variable
IS_INTERNET_FACINGLocal variable
MAC_ADDRESSESmacAddresses
MEMORY_SIZELocal variable
MODEL_TAGSLocal variable
NAMEname
OBSERVATIONSLocal variable
ORCA_SCORELocal variable
ORCA_TAGSLocal variable
OWNERowner
PII_TYPESLocal variable
PRIVATE_DNSSprivateDnsNames
PRIVATE_IPSprivateIpAddresses
PUBLIC_DNSSpublicDnsNames
PUBLIC_IPSpublicIpAddresses
PUBLIC_IMAGELocal variable
REGIONSLocal variable
REGION_NAMESLocal variable
REGIONregion
RELATED_COMPLIANCELocal variable
RISK_LEVELLocal variable
SCORELocal variable
SECURITY_GROUPSLocal variable
STATELocal variable
STOP_DATELocal variable
SUBCATEGORYLocal variable
SUBNETSLocal variable
SYS_IDuid
TAGStags
TOTAL_DISK_BYTESLocal variable
UP_TIMELocal variable
UP_TIME_HOURSLocal variable
UPDATED_TIMEsourceLastModified
VIRTUAL_CPU_COUNTLocal variable
VPCSLocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Virtual Machine Image

Table 14: Virtual Machine Image attribute mappings

Source Field NameMaps to Attribute
APPLICATIONSLocal variable
ASSET_TYPEtype
AUTO_UPDATES_STATUSLocal variable
AVAILABILITY_ZONESLocal variable
CATEGORYcategories
CPU_COUNTLocal variable
CPU_FREQUENCYLocal variable
CPU_TYPELocal variable
CREATION_TIMEsourceCreatedDate
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
DETECTED_CROWN_JEWEL_REASONLocal variable
DETECTED_CROWN_JEWEL_SCORELocal variable
DISTRIBUTION_CATEGORYLocal variable
DISTRIBUTION_MAJOR_VERSIONLocal variable
DISTRIBUTION_NAMELocal variable
DISTRIBUTION_VERSIONLocal variable
ESM_STATUSLocal variable
EXPOSURELocal variable
HOST_NAMEhostnames
IMAGE_DESCRIPTIONLocal variable
IMAGE_IDLocal variable
IMAGE_NAMELocal variable
IMAGE_OWNER_IDLocal variable
IS_INTERNET_FACINGLocal variable
MAC_ADDRESSESmacAddresses
MEMORY_SIZELocal variable
MODEL_TAGSLocal variable
NAMEname
OS_BIT_MODELocal variable
OS_END_OF_SUPPORTLocal variable
OS_SUPPORT_INFO_SITELocal variable
OWNERowner
PRIVATE_DNSSprivateDnsNames
PRIVATE_IPSprivateIpAddresses
PUBLIC_DNSSpublicDnsNames
PUBLIC_IPSpublicIpAddresses
REGIONSLocal variable
REGION_NAMESLocal variable
SECURITY_GROUPSLocal variable
STATELocal variable
STOP_DATELocal variable
SUBNETSLocal variable
SYS_IDuid
TAGStags
TOTAL_DISK_BYTESLocal variable
UP_TIMELocal variable
UP_TIME_HOURSLocal variable
UPDATED_TIMEsourceLastModified
VIRTUAL_CPU_COUNTLocal variable
VPCSLocal variable
ZONESLocal variable
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Vulnerability

Table 15: Vulnerability attribute mappings

Source Field NameMaps to Attribute
ASSET_NAMELocal variable
ASSET_SYS_IDLocal variable
ASSET_TYPELocal variable
ASSET_UIDtargets
CLOUD_ACCOUNT_IDcloudAccountId
CLOUD_ACCOUNT_NAMELocal variable
CLOUD_ACCOUNT_TYPELocal variable
CLOUD_PROVIDERcloudProvider
CLOUD_PROVIDER_IDLocal variable
CLOUD_VENDOR_IDLocal variable
CVE_IDtype
FIRST_FOUNDfirstFound
FIX_AVAILABLEfixable
LAST_FOUNDlastFound
STATUSstatus, sourceStatus
SYS_IDuid
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Vulnerability Definition

Table 16: Vulnerability Definition attribute mappings

Source Field NameMaps to Attribute
ATTACK_VECTORLocal variable
CISA_KEVLocal variable
CVSS2_SCOREcvssV2BaseScore
CVSS2_VECTORcvssV2Vector
CVSS3_SCOREcvssV3BaseScore
CVSS3_VECTORcvssV3Vector
CWEScweIds
DESCRIPTIONdescription
HAS_EXPLOITcisaExploited
LAST_MODIFIED_DATEsourceLastModified
NAMEname
PUBLISHEDpublishedDate
SOURCE_LINKurl
SYS_IDuid
USER_INTERACTIONLocal variable
VENDOR_LINKreferences
INFO

Local variable indicates that the field is processed within a specific context, such as a particular workflow or calculation. Unlike other attributes, local variables aren't mapped to the unified data models. They only exist on the source data model.

Operation options

The Orca connector supports the following operation options. See connector operation options for information about how to apply them.

Table 17: Orca connector operation options

Connector ObjectOptionAll Possible valuesDescriptionExample
Alert,
Alert Definition
assetCategoryAny Orca asset category.Retrieve alerts from the specified asset category.Key: assetSubcategory Value: Data Storage. This key and value combination only retrieves alerts from your Orca data storages.
show_informational_alertsfalseFilters out informational alerts. By default, the Orca connector retrieves informational alerts.Key: show_informational_alerts Value: false. This key and value combination filters out informational alerts when retrieving alerts.
show_snoozed_alertsfalseFilter out snoozed alerts. By default, the Orca connector retrieves snoozed alerts.Key: show_snoozed_alerts Value: false. This key and value combination filters out snoozed alerts when retrieving alerts.
sla_violation_alertsfalseFilters out alerts that are in violation of their SLA.Key: sla_violation False: false. This key and value combination filters out alerts that in violation of their SLA.
Installed Package,
Package
releaseDateInPastDaysAny numeric value in daysRetrieve packages released since the specified number of days.Key: releaseDateInPastDays Value: 30. This key and value combination only retrieves packages released in the past 30 days.
Vulnerability,
Vulnerability Definition
assetCategoryAny Orca asset category.Retrieve vulnerabilities from the specified asset category.Key: assetSubcategory Value: Compute Services. This key and value combination only retrieves vulnerabilities from your Orca compute services.
assetSubcategoryAny Orca asset subcategory.Retrieve vulnerabilities from the specified asset subcategory.Key: assetSubcategory Value: Buckets. This key and value combination only retrieves vulnerabilities from your Orca Buckets.
cisaKevtrueRetrieve vulnerabilities that are listed in the CISA Known Exploited Vulnerabilities (KEV) catalog.Key: cisaKev Value: true. This key and value combination only retrieves vulnerabilities listed in the CISA KEV catalog.
cvss3ScoreAny numeric value from 0.1-10.0Retrieve all vulnerabilities with a CVSS3 (Common Vulnerability Scoring System) score of the specified value or higher.Key: cvss3Score Value: 7. This key and value combination only retrieves vulnerabilities with a CVSS3 score of 7 or higher.
hasExploittrueRetrieve vulnerabilities for which an exploit is known to be available.Key: hasExploit Value: true. This key and value combination only retrieves vulnerabilities that have a known exploit available.
isTrendingtrueRetrieve trending vulnerabilities.Key: isTrending Value: true. This key and value combination retrieves only trending vulnerabilities.
note

The option keys and values are case-sensitive as they are shown in this documentation.

APIs

The Orca connector uses the Orca REST API. Expand the sections below to view the specific endpoints along with their associated payloads:

Orca service layer API

Versions 3.1.0 and later of the Orca connector use the Orca service layer API. If your environment does not have service layer API access, please contact Orca to enable it. Alternatively, you can contact Brinqa Support to downgrade to version 3.0.x of the connector if you don't want to enable the service layer API.

Alert API

GET api/query/alerts
POST api/query/alerts

{
"unique_list": "account_name",
"unique_list_include_zero": true
}
Alert Definition API

GET api/query/alerts
POST api/query/alerts

{
"unique_list": "account_name",
"unique_list_include_zero": true
}
Cloud Account API

POST /api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 5000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"CloudAccount"
],
"keys": [
"CloudAccount"
],
"with": {
"type": "operation",
"operator": "and",
"values": []
}
}
}
Container API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 0,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Container"
],
"keys": [
"Container"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T11:24:05.276Z"
]
}
]
}
}
}
Container Image API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 2000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"ContainerImage"
],
"keys": [
"ContainerImage"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T11:31:53.458Z"
]
}
]
}
}
}
Database API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 0,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Inventory"
],
"keys": [
"Inventory"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "NewSubCategory",
"type": "str",
"operator": "in",
"values": [
"Databases"
]
}
]
}
}
}
Function API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 3000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Function",
"AwsLambdaFunction",
"AzureFunction",
"GcpCloudFunction"
],
"keys": [
"Function",
"AwsLambdaFunction",
"AzureFunction",
"GcpCloudFunction"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T11:37:26.183Z"
]
}
]
}
}
}
Installed Package API

POST api/sonar/query/

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 0,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"InstalledPackage"
],
"keys": [
"InstalledPackage"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "InstallDate",
"type": "datetime",
"operator": "in_past",
"value_type": "days",
"values": [
4
]
}
]
}
}
}
Package API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 4000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Package"
],
"keys": [
"Package"
],
"with": {
"type": "operation",
"operator": "and",
"values": []
}
}
}
Storage API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 0,
"additional_models[]": [
"CloudAccount",
"Content.Storage"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Inventory"
],
"keys": [
"Inventory"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "NewSubCategory",
"type": "str",
"operator": "in",
"values": [
"Buckets"
]
},
{
"key": "UpdatedTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T12:47:23.166Z"
]
}
]
}
}
}
User API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 6000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"User"
],
"keys": [
"User"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "CreationTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-02T20:05:22.735Z"
]
}
]
}
}
}
Virtual Machine API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 1000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Vm"
],
"keys": [
"Vm"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T14:31:16.335Z"
]
}
]
}
}
}
Virtual Machine Image API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 4000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"VmImage"
],
"keys": [
"VmImage"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T14:35:30.596Z"
]
}
]
}
}
}
Vulnerability API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 4000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"VmImage"
],
"keys": [
"VmImage"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "LastUpdateTime",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-03T14:35:30.596Z"
]
}
]
}
}
}
Vulnerability Definition API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 4000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"Vulnerability"
],
"keys": [
"Vulnerability"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "FirstSeen",
"type": "datetime",
"operator": "date_gte",
"value_type": "days",
"values": [
"2024-05-07T14:45:03.363Z"
]
},
{
"type": "object_set",
"operator": "has",
"models": [
"CVE"
],
"keys": [
"CVE"
],
"with": {
"type": "operation",
"operator": "and",
"values": []
}
},
{
"type": "object_set",
"operator": "has",
"models": [
"Content"
],
"keys": [
"Content"
],
"with": {
"type": "operation",
"operator": "and",
"values": [
{
"key": "NewSubCategory",
"type": "str",
"operator": "in",
"values": [
"Virtual Instances"
]
}
]
}
},
{
"type": "object_set",
"operator": "has",
"models": [
"CVEDescription"
],
"keys": [
"CVEVendorData"
],
"with": {
"type": "operation",
"operator": "and",
"values": []
}
}
]
}
}
}
Vulnerability Package API

POST api/sonar/query

{
"ui": false,
"enable_pagination": true,
"limit": 1000,
"start_at_index": 4000,
"additional_models[]": [
"CloudAccount"
],
"query": {
"type": "object_set",
"operator": "has",
"models": [
"VulnerablePackage"
],
"keys": [
"VulnerablePackage"
],
"with": {
"type": "operation",
"operator": "and",
"values": []
}
}
}

Changelog

The Orca connector has undergone the following changes:

3.1.0

  • Added support for the Orca service layer API.

3.0.2

  • Changed the DISTRIBUTION_VERSION attribute type on the Container, Function, and Virtual Machine objects from string to integer.

3.0.1

  • Removed the use of Immutableset.

3.0.0