Breach Watch Report Command

Breach Watch Report

This command/function runs a BreachWatch security report for all users in your enterprise.

DotNet CLI

Command: breachwatch-report

It runs a Breach Watch security report for all users in your enterprise.

Parameter:

--format - Display the report in these formats json, table, csv

--output - Store the output in a file.

Examples:

My Vault> breachwatch-report --format csv --output breachwatch_report.csv

DotNet SDK

Comming Soon

PowerCommander

Command: Get-KeeperBreachWatchReport

It runs a Breach Watch security report for all users in your enterprise.

Parameter:

-Format - Display the report in these formats json, table, csv

-Output - Store the output in a file.

Examples:

PS> Get-KeeperBreachWatchReport -Format json

Security scores pushed to Keeper.
[
  {
    "email": "[email protected]",
    "name": "test",
    "sync_pending": "",
    "at_risk": 170,
    "passed": 1446,
    "ignored": 0
  },
  {
    "email": "[email protected]",
    "name": "testqa",
    "sync_pending": "",
    "at_risk": 4,
    "passed": 0,
    "ignored": 0
  },
]

Python CLI

Command: breach-watch report

Flag:

--format : format of output {table,csv,json,pdf}. --output : path to resulting output file (ignored for "table" format).

Example:

My Vault> breachwatch report
Generating BreachWatch security audit report...
Saved 31 updated security report(s).

Security Audit Report (BreachWatch)

Email                              Name                   Sync Pending      At Risk    Passed    Ignored
---------------------------------  ---------------------  --------------  ---------  --------  ---------
[email protected]         b.ranjan                                   0        -4          0
[email protected]          M.Naqvi                                   0         0          0
[email protected]       A.Deshmukh      

Python SDK

Function:

def run_breachwatch_report(
    enterprise_data: enterprise_types.IEnterpriseData,
    auth: keeper_auth.KeeperAuth,
    node_ids: Optional[List[int]] = None,
    save_report: bool = True,
) -> BreachWatchReportResult:
    generator = BreachWatchReportGenerator(