Share Report Command

Share Report Command

This command/function helps to display a report of shared records and shared folders. Supports multiple modes: summary, per-record detail, per-user filter, shared folders listing and owner report.

DotNet CLI

Coming soon

DotNet SDK

Comming Soon

PowerCommander

Command: Get-KeeperShareReport

Show a report of shared records and shared folders. Supports multiple modes: summary, per-record detail, per-user filter, shared folders listing, and owner report

Parameter:

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

-Output - Path to write the report to a file

-Record - Record name(s) or UID(s) to show share information

-Email - User email(s) or team name(s) to filter the report

-Owner - Show record ownership information in the report.

-ShareDate - Include the date when each record was shared. Requires enterprise admin with report permissions. Only applies to the owner report (-Owner)

SharedFolders - Display shared folder detail instead of records. Used with -Email

-Folders - Limit the report to shared folders only (excludes shared records)

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

Examples:

PS > Get-KeeperShareReport 
Share Report Summary

Shared To                     Records Shared Folders
---------                     ------- --------------
[e-mail]               1
[e-mail]                 170 2
share_test_team                   170 2

Python CLI

Command: share-report

Flag:

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

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

• -r, --record record name or UID

• -e, --email user email or team name

• -o, --owner record ownership information

• --share-date include date when the record was shared. This flag will only apply to the detailed owner report. This data is available only to those users who have permissions to execute reports for their company. Example of the report that includes shared date: share-report -v -o --share-date --format table

• -sf, --shared-folders display shared folder detail information. If omitted then records.

• -v, --verbose display verbose information

• -f, --folders limit report to shared folders (excludes shared records)

• -tu, --show-team-users show shared-folder team members (to be used with "--folders"/ "-f" flag, ignored for non-admin accounts)

Example:

My Vault> share-report --email <email>
My Vault> share-report --record 

Python SDK

Function:

def generate_report(self) -> List[SharedRecordReportEntry]:
        """Generate the shared records report.
        
        Returns:
            List of SharedRecordReportEntry objects containing share information
        """
        records = self._get_records_to_report()
        if not records:
            return []