# 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.

<details>

<summary>DotNet CLI</summary>

**Coming soon**

</details>

<details>

<summary>DotNet SDK</summary>

Comming Soon

</details>

<details>

<summary>PowerCommander</summary>

**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:**

{% code overflow="wrap" %}

```powershell
PS > Get-KeeperShareReport 
Share Report Summary

Shared To                     Records Shared Folders
---------                     ------- --------------
test+qa@example.com               1
test1@example.com                 170 2
share_test_team                   170 2
```

{% endcode %}

</details>

<details>

<summary>Python CLI</summary>

**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 
```

</details>

<details>

<summary>Python SDK</summary>

**Function:**

```python
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 []
```

</details>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.keeper.io/keeperpam/commander-sdk/keeper-commander-sdks/sdk-command-reference/reporting-commands/share-report-command.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.