External Shares Report Command

Lists direct record shares and shared-folder user memberships where the recipient is an external user.

External Shares Report

This command/function helps to display a List of direct record shares and shared-folder user memberships where the recipient is an external user.

chevron-rightDotNet CLIhashtag

Command: audit-report --limit 50

It returns a list of reports with created date, username, event type and message.

Parameter:

limit - Limit number of rows.

Examples:

My Vault> audit-report --limit 50
chevron-rightDotNet SDKhashtag

Comming Soon

chevron-rightPowerCommanderhashtag

Command: Get-KeeperExternalSharesReport

Parameter:

Parameter
Description

-Format

table (default), json, or csv.

-Output

File path for json or csv. Not used for table.

-Action

none (default): list only. remove: revoke external shares matching the filters.

-ShareType

all (default), direct (record shares only), or shared-folder (shared folder user access only).

-Force

With -Action remove, skip the confirmation prompt and remove immediately.

-RefreshData

Rebuild the compliance snapshot before evaluating external shares.

Examples:

PS > Get-KeeperExternalSharesReport                             
            
uid                    name                   type          shared_to                                  permissions
---                    ----                   ----          ---------                                  -----------
cDx8KS1zVbOH1GnNHJT7_Q Gmail Account          Direct        test1@example.com                          read-only
cDx8KS1zVbOH1GnNHJT7_Q Gmail Account          Direct        test2@example.com                          read-only
Oz0yr-Ua45lsojNZAqbUQA Commander Service Mode Direct        test2@example.com                          edit,share
chevron-rightPython CLIhashtag

Command: external-shares-report

Flag:

--format : format of output {table,csv,json,pdf}. --output : path to resulting output file (ignored for "table" format). -a, --action : action to perform on external shares, 'none' if omitted {remove,none}. -t, --share-type : filter report by share type, 'all' if omitted {direct,shared-folder,all}. -f, --force : apply action w/o confirmation. -r, --refresh-data : retrieve fresh data.

Example:

External Shares Report

UID                     Name                                               Type           Shared To    Permissions
----------------------  -------------------------------------------------  -------------  -----------  -------------
LXp-qBKq0E7j7Uu_ZtMjRg  just testing                                       Direct                      read-only
Mpn1zqYkEUXTJDm3JQShfw  new-record                                         Direct                      read-only
chevron-rightPython SDKhashtag

Function:

def run_external_shares_report(
    vault: vault_online.VaultOnline,
    include_expired: bool = False,
    share_type: str = SHARE_TYPE_ALL,
) -> ExternalSharesReportResult:

Last updated

Was this helpful?