Compliance Reports

Keeper Commander compliance reporting commands

About

Requires Compliance Reporting add-on
Compliance reports let account administrators adhere to regulations by providing on-demand visibility to access permissions on records and credentials across the enterprise.
Using Commander, compliance reports can be scheduled and automated, and results can be exported to a CSV file or JSON.
For more information about Compliance Reports, see the Compliance Reports documentation:

The compliance-report command

The compliance-report command allows you to run reports just as you would in the Keeper Admin Console. See record permissions by node, user and title, filter by owned or shared records and output results to a file.

Cache

The compliance-report command relies on a cache in order to improve performance across multiple report queries.
This means that the first call to compliance-report may take several minutes as the system pulls in the required data.
During this time, Commander will display messaging explaining the current step.
Additionally, a manual rebuild of the cache can be performed with the -r flag. Do this to see recent changes in the compliance data.
compliance-report -r
Removing the Cache
The compliance report cache can be removed manually with the --no-cache flag. When run, this completely removes all cached compliance report information from your machine.
compliance-report --no-cache
Alternatively, you can delete the cache file locally on disk from the location where you ran Commander. Delete the file called sox_<ID>.db which contains the encrypted compliance data.

Filters

The compliance report can be filtered by Node, User, Job Title and if the record is shared.

Format

--node [NODE NAME or ID] or -n [NODE NAME or ID]
Example
compliance-report --node "Chicago Office"

About

Filters the record results to only records that exist in Keeper Vaults in the given Node. By default this uses the root enterprise node and searches all vaults.

Format

--username [USER EMAIL] or -u [USER EMAIL]
Example
compliance-report --username "[email protected]"

About

Filters the record results to only records that exist in the Keeper Vault of the given username

Format

--record [UID or TITLE] or -r [UID or TITLE]
Example
compliance-report --record "Twitter Login"

About

Filters the results to the record with the given UID or title

Format

--url [URL]
Example
compliance-report --url "https://www.twitter.com"

About

Filters the results to records with the given URL value

Format

--job-title [TITLE] or -jt [TITLE]
Example
compliance-report --job-title "Engineers"

About

Filters the record results to only records that exist in Keeper Vaults owned by users with the given title

Format

--shared
Example
compliance-report --shared

About

Only shows records that have been shared
Requires Commander version 16.7.5+
Format
--team <TEAM NAME>
Example
compliance-report --team "Engineering"
About
Show only users which are in the given team
Requires Commander version 16.7.5+
Format
--record <RECORD NAME or UID>
Example
compliance-report --record "Twitter Login"
About
Show report for the given record
The filter flags can be used together to create advanced reports
Example
compliance-report --node "Chicago" --job-title "Managers" --shared
This example shows a report of records that have been shared from Vaults owned by Managers in the Chicago Node.
The same filter can also be used multiple times
compliance-report -u "[email protected]" -u "[email protected]"
This example retrieves records for both users "[email protected]" and "[email protected]"

About

Filters the record results to only records that exist in Keeper Vaults in the given Node

Outputting to a File

Like many Commander reports, the compliance report results can be saved to a file. To do this use the --output and --format options.
Output
--output [FILE PATH]
Tells Commander to write results to a file at the given location. If no file exists it will be created.
Format
--format [csv, json, table]
Tells Commander the format to write the report results as. The default result is in table format, which displays a formatted table of results. The other options are Comma Separated Values (CSV), JavaScript Object Notation (JSON).
If the --format flag is added without the --output flag, the results will be shown in Commander in the the given format
To save compliance report results as a CSV file viewable in Excel, use the following flags:
--format csv and --output /path/to/file.csv

Example

compliance-report --username "[email protected]" --format csv --output "./craig_compliance.csv"
The results will be saved as a csv formatted file at the given location
To save compliance report results as a CSV file to use in code or scripting, use the following flags:
--format json and --output /path/to/file.json

Example

compliance-report --username "[email protected]" --format csv --output "./craig_compliance.json"
The results will be saved as a json formatted file at the given location

Compliance Team Report

Shared folders can be shared to Keeper Teams as well as individuals. The compliance report can display a report of the access that each team has to these shared folders.
To run the Compliance Team Report, use the following command in Commander:
compliance team-report
This report uses the compliance report cache described above.
The report shows each team that has access to a shared folder, and what access it has to that shared folder.
My Vault> compliance team-report
Team Name Shared Folder Name Shared Folder UID Permissions
----------- -------------------- ---------------------- -------------
Engineering Devops Secrets 8-2gk4cUdde3es567NwpCA read-only
Marketting Website Logins 5v3lduLYf81CED5N4dOKEA edit, share
See the Reporting Documentation for other reports available in Commander