Compliance command
Overview
This is the set of commands which we use related to sharing with user
Compliance Report
The compliance-report command allows administrators to generate compliance reports from the command line just as they would in the Keeper Admin Console. It provides visibility into record permissions by node, user, and record title, supports filtering by owned or shared records, and enables exporting the results to a file for auditing, analysis, or record-keeping purposes.
Python CLI
Command: compliance report
Flags:
--format : Format of output {table,csv,json}.
--output : Output path to resulting output file (ignored for "table" format).
--rebuild, -r : rebuild local data from source.
--no-rebuild, -nr : prevent remote data fetching if local cache present.
--no-cache, -nc : remove any local non-memory storage of data after report is generated.
--node : Node ID or name of node (defaults to root node).
--regex : Allow use of regular expressions in search criteria.
--username, -u : Username user(s) whose records are to be included in report.
--job-title, -jt : JOB_TITLE job title(s) of users whose records are to be included in report.
--team : Team name or UID of team(s) whose members' records are to be included in report.
--record : Record UID or title of record(s) to include in report.
--url URL : URL of record(s) to include in report.
--shared : Show shared records only.
--deleted-items : Show deleted records only.
--active-items : Show active records only.
Example:
Compliance Team Report
Shared folders can be shared with both Keeper Teams and individual users. The compliance report provides visibility into shared folder access, allowing administrators to view the permissions and access levels that each team has to these shared folders.
Python CLI
Command: compliance team-report
Flags:
--format : Format of output {table,csv,json}.
--output : Output path to resulting output file (ignored for "table" format).
--rebuild, -r : Rebuild local data from source.
--no-rebuild, -nr : Prevent remote data fetching if local cache present.
--no-cache, -nc : Remove any local non-memory storage of data after report is generated.
--node : Node ID or name of node (defaults to root node).
--regex : Allow use of regular expressions in search criteria.
--show-team-users, -tu : show all members of each team.
Example:
Compliance Record Access Report
The compliance record-access report provides a list of all records that have either (a) been accessed by or (b) are currently accessible to specified user(s). The report also includes relevant event details such as the application used, IP address, timestamp, and other associated access information for auditing and compliance purposes.
Python CLI
Command: compliance record-access-report
Flags:
--format : Format of output {table,csv,json}.
--output : Output path to resulting output file (ignored for "table" format).
--rebuild, -r : Rebuild local data from source.
--no-rebuild, -nr : Prevent remote data fetching if local cache present.
--no-cache, -nc : Remove any local non-memory storage of data after report is generated.
--node : Node ID or name of node (defaults to root node).
--regex : Allow use of regular expressions in search criteria.
--username, -u : Username user(s) whose records are to be included in report.
--email, -e : Email username(s) or ID(s), use "@all" for all users.
--report-type : Type of record-access data: "history" or "vault" {history,vault}.
--aging : Include record-aging data.
Example:
Compliance Summary Report
The compliance summary report displays aggregated information about records within the enterprise, grouped by record owner by default. Support for grouping by additional entities may be added in future enhancements to this feature.
Python CLI
Command: compliance summary-report
Flags:
--format : Format of output {table,csv,json}.
--output : Output path to resulting output file (ignored for "table" format).
--rebuild, -r : Rebuild local data from source.
--no-rebuild, -nr : Prevent remote data fetching if local cache present.
--no-cache, -nc : Remove any local non-memory storage of data after report is generated.
--node : Node ID or name of node (defaults to root node).
--regex : Allow use of regular expressions in search criteria.
Example:
Compliance Shared Folder Report
Similar to the compliance team-report command, this command generates a report detailing the access that all entities—both teams and individual users—have to all shared folders across the enterprise.
Python CLI
Command: compliance shared-folder-report
Flags:
--format : Format of output {table,csv,json}.
--output : Output path to resulting output file (ignored for "table" format).
--rebuild, -r : Rebuild local data from source.
--no-rebuild, -nr : Prevent remote data fetching if local cache present.
--no-cache, -nc : Remove any local non-memory storage of data after report is generated.
--node : Node ID or name of node (defaults to root node).
--regex : Allow use of regular expressions in search criteria.
--show-team-users, -tu : Show all members of each team.
Example:
Last updated
Was this helpful?