Shared Records Report Command

Shared Records Report

This command/function helps to display a Report shared records for the logged-in user. Generates a report of all shared records showing the share type (Direct Share, Share Folder, Share Team Folder), recipient, permissions, and folder path. By default only owned shared records are included. Use -AllRecords to include non-owned records,

chevron-rightDotNet CLIhashtag

Coming Soon

chevron-rightDotNet SDKhashtag

Comming Soon

chevron-rightPowerCommanderhashtag

Command: Get-KeeperSharedRecordsReport

Alias: ksrr

Generates a report of all shared records showing the share type, recipient, permissions, and folder path

Parameter:

-ShowTeamUsers - Expand team shares to show individual team members. Requires enterprise admin

-AllRecords - Include all shared records in the vault, not just records owned by the current user

-Folder - Folder path(s) or UID(s) to scope the report to records within those folders.

-Format - Output format: table, json, or csv

-Output - Path to write the report to a file

Examples:

PS > Get-KeeperSharedRecordsReport

Shared Records Report

Record UID             Title Share Type   Shared To                     Permissions      Folder Path
----------             ----- ----------   ---------                     -----------      -----------
zsaOU8Rusa6C05EVEC-wCQ a1    Direct Share user+qa@example.com         Can Share & Edit Shared Accounts
chevron-rightPython CLIhashtag

Command: shared-record-report

Alias: srr

Flag:

  • --format format of output {table,csv,json}.

  • --output Output path to resulting output file (ignored for "table" format)

  • -tu, --show-team-users show members of team for records shared via share team folders.

  • --all-records report on all records in the vault. only owned records are included if this argument is omitted.

Example:

My Vault> shared-records-report --all-records --format json --output json
chevron-rightPython SDKhashtag

Function:

def generate_shared_folders_report(self) -> List[SharedFolderReportEntry]:
        """Generate a report of shared folders and their permissions.
        
        Returns:
            List of SharedFolderReportEntry objects containing folder share information
        """
        entries: List[SharedFolderReportEntry] = []

Last updated

Was this helpful?