Compliance

Provides access to details about resource Compliance in OpsCompass.

list-checks-with-details

Retrieves the list of compliance checks for the specified company, with the amount of active resource problems and compliance score impact for each check
Parameters:
--company [company_slug]
--accounts (optional) [account_id]

list-disabled-checks

Retrieves the list of disabled compliance checks for the specified company, with the amount of resources that each check is not scanning against.
Parameters:
--company [company_slug]
--accounts (optional) [account_id]

list-frameworks

Retrieves the list of compliance frameworks available for the specified company
Parameters:
--company [company_slug]

list-frameworks-with-details

Retrieves the list of compliance frameworks available for the specified company, with the amount of active control problems and compliance score for each framework
Parameters:
--company [company_slug]
--accounts [account_id]

get-upcoming-exception-info

Retrieves the soon to be expiring compliance exception information for the specified company.
Parameters:
--company [company_slug]
--accounts (optional) [account_id]
--frameworkId (optional) [compliance_framework_id]

get-check-status-overview

Retrieves an overview of compliance check statuses, associated with a company.
Parameters:
--company [company_slug]
--accounts (optional) [account_id] Ex. --accounts account_123,account_456
--frameworkId (optional) [compliance_framework_id] Ex. --frameworkId 28

get-compliance-problems-over-time

Retrieves a list of aggregated information about compliance problems over a specified timeframe.
Parameters:
--company [company_slug]
--start-date [2020-11-11 00:00:00.000]
--end-date [2020-11-15 00:00:00.000
--accounts (optional) [account_id] Ex. --accounts account_123,account_456
--frameworkId (optional) [compliance_framework_id] Ex. --frameworkId 28

transfer-oracle-database-metadata

Transfers OpsCompass Oracle Database metadata report into OpsCompass for processing
Parameters:
--company [company_slug]
--type [licensing | compliance | ebusiness]
--filePath [path] Path of the file to transfer to OpsCompass for processing.

transfer-vmware-vsphere-metadata

Transfers OpsCompass VMware VSphere metadata report into OpsCompass for processing
Parameters:
--company [company_slug]
--filePath [path] Path of the file to transfer to OpsCompass for processing.

transfer-sql-server-database-metadata

Transfers OpsCompass SQL Server Database metadata report into OpsCompass for processing
Parameters:
--company [company_slug]
--type [licensing | compliance]
--filePath [path] Path of the file to transfer to OpsCompass for processing.

transfer-network-discovery-metadata

Transfers OpsCompass Network Discovery metadata into OpsCompass for processing
Parameters:
--company [company_slug]
--filePath [path] Path of the file to transfer to OpsCompass for processing.

list-compliance-exceptions

Gets list of policy exceptions and mitigations
Parameters:
--company [company_slug]
--from-index (optional) [number] the record index to start at when fetching the next round of records (helps with fetching all records over multiple requests)
--number-of-records (optional) [number] the number of records to fetch with one request
--compliance-exception-sort: (optional) [resource | check | type | created-at | expires-at | reason] the column on which to sort records by
--compliance-exception-sort-direction: (optional) [asc | desc] the direction to sort records by
--search-text: (optional) [string] search columns by this text
--type-filter: (optional) [mitigation and/or policy_exception] filter results by type. Ex: --type-filter "policy_exception, mitigation"
--status-filter: (optional) [active and/or expired] filter results by status. Ex: --status-filter "expired, active"
--expires-at-from: (optional) [string] the date at which to not show records before.
Format: UTC, example: '2022-08-23T17:00:00Z' to filter by August 8th, 2022 at 17:00 UTC.
--expires-at-to: (optional) [string] the date at which to not show records after.
Format: UTC, example: '2022-08-23T17:00:00Z' to filter by August 8th, 2022 at 17:00 UTC.
--check-ids-filter: (optional) [string] check ids to filter records by. Ex: --check-ids-filter "123, 456, 789"
--resource-ids-filter: (optional) [string] resource ids to filter records by. Ex: --resource-ids-filter "123, 456, 789"
--creator-ids-filter: (optional) [string] user ids to filter records by. Ex: --creator-ids-filter "123, 456, 789"

update-compliance-exception

Updates single compliance exception record (i.e. mitigations and policy exceptions)
Parameters:
--id [record id]
--reason [string] the reason for the compliance exception
--expiresAt [string] the date at which to expire. If you want to remove a compliance exception from the list, set the expiresAt to todays date.
Format: UTC, example: '2022-08-23T17:00:00Z' to expire August 8th, 2022 at 17:00 UTC. To remove this field, pass in null.

update-compliance-exceptions

Updates multiple compliance exceptions (i.e. mitigations and policy exceptions)
Parameters:
--id [record id]
--reason (optional) [string] the reason for the compliance exception
--expiresAt (optional) [string] the date at which to expire. If you want to remove a compliance exception from the list, set the expiresAt to todays date.
Format: UTC, example: '2022-08-23T17:00:00Z' to expire August 8th, 2022 at 17:00 UTC. To remove this field, pass in null.
OR --json-updates [stringified json objects with your updates]
For quick updates, you may use the above parameters
e.g. opscompass compliance update-compliance-exceptions --id 18 --reason "Valid exception reason" --id 3 --expires-at "09/15/2022"
For larger updates, JavaScript Object Notation (JSON) may be used with the --json-updates flag
e.g. opscompass compliance update-compliance-exceptions --json-updates '[{"id":"18","reason":"Valid exception reason"},{"id":"3","expiresAt":"2022-08-23T17:00:00Z"}]'

create-compliance-resource-check-exceptions

Creates a new compliance resource check exception
Parameters:
--compliance-resource-check-id [the compliance resource check id]
--compliance-exception-type [string] the type of compliance exception: 'mitigation' or 'policy_exception'
--reason [string] the reason for the compliance resource check exception
--expires-at (optional) [string] the date at which to expire. If you want to remove a compliance exception from the list, set the expiresAt to todays date.
Format: UTC, example: '2022-08-23T17:00:00Z' to expire August 8th, 2022 at 17:00 UTC.

list-breaches

Retrieves the list of breaches company emails have been involved in.
Parameters:
--company [company_slug]

list-breached-emails

Retrieves the list of breached emails associated with a provided company
Parameters:
--company [company_slug]

list-breached-emails-of-concern

Retrieves the list of breached emails that have not performed a password reset since a data breach.
Parameters:
--company [company_slug]