77 lines
4.2 KiB
Markdown
77 lines
4.2 KiB
Markdown
# Google Workspace Auditor script
|
|
This script collects users, groups and Shared Drives of a Google Workspace environment on .xlsx file for audit and review purposes
|
|
|
|
<!-- buttons -->
|
|
[](https://github.com/ivancarlosti/gwauditor/stargazers)
|
|
[](https://github.com/sponsors/ivancarlosti)
|
|
[](https://github.com/sponsors/ivancarlosti)
|
|
[](https://github.com/ivancarlosti/gwauditor/pulse)
|
|
[](https://github.com/ivancarlosti/gwauditor/issues)
|
|
[](LICENSE)
|
|
[](https://github.com/ivancarlosti/gwauditor/commits)
|
|
[](https://github.com/ivancarlosti/gwauditor/security)
|
|
[](https://github.com/ivancarlosti/gwauditor?tab=coc-ov-file)
|
|
[][sponsor]
|
|
<!-- endbuttons -->
|
|
|
|
## Details
|
|
This script collects users, groups, mailboxes delegation, Shared Drives, YouTube accounts, Analytics accounts, policies of a [Google Workspace](https://workspace.google.com/) environment on .xlsx file for audit and review purposes, the file is archived in a .zip file including a screenshot with hash MD5 of the .xlsx file and the script executed. Note that it's prepared to run on [GAM](https://github.com/GAM-team/GAM/) configured for multiple projects, change accordly if needed. This project also offer extra features:
|
|
- Archive mailbox messages to group
|
|
- List, add or remove mailbox delegation
|
|
|
|
Set variables if different of defined:
|
|
```
|
|
$GAMpath = "C:\GAM7"
|
|
$gamsettings = "$env:USERPROFILE\.gam"
|
|
$destinationpath = (New-Object -ComObject Shell.Application).NameSpace('shell:Downloads').Self.Path
|
|
```
|
|
|
|
`$GAMpath` defines the GAM application folder
|
|
|
|
`$gamsettings` defines the settings folder of GAM
|
|
|
|
`$destinationpath` defines the location were script result is saved
|
|
|
|
Check `testing-guideline.md` file as suggestion for testing guideline
|
|
|
|
You can find scripts related to mailbox delegation and mailbox archive to group in `Other scripts` folder
|
|
|
|
## Instructions
|
|
* Save the last release version and extract files locally (download [here](https://github.com/ivancarlosti/gwauditor/releases/latest))
|
|
* Change variables of `mainscript.ps1` if needed
|
|
* Run `mainscript.ps1` on PowerShell (right-click on file > Run with PowerShell)
|
|
* Follow instructions selecting project name, option 1 to generate audit report and collect .zip file on `$destinationpath`
|
|
|
|
## Screenshots
|
|
*parts ommited on screenshots are related to project/profile name
|
|
|
|
|
|
*Script startup*
|
|
|
|
|
|
*Script completed*
|
|
|
|
|
|
*.zip file content*
|
|
|
|
## Requirements
|
|
* Windows 10+ or Windows Server 2019+
|
|
* [GAM v5+](https://github.com/GAM-team/GAM/) using multiproject setup
|
|
* PowerShell
|
|
* Module `ImportExcel` on PowerShell (not required to run extra features)
|
|
|
|
<!-- footer -->
|
|
---
|
|
|
|
## 🧑💻 Consulting and technical support
|
|
* For personal support and queries, please submit a new issue to have it addressed.
|
|
* For commercial related questions, please [**contact me**][ivancarlos] for consulting costs.
|
|
|
|
| 🩷 Project support |
|
|
| :---: |
|
|
If you found this project helpful, consider [**buying me a coffee**][buymeacoffee]
|
|
|Thanks for your support, it is much appreciated!|
|
|
|
|
[ivancarlos]: https://ivancarlos.me
|
|
[buymeacoffee]: https://www.buymeacoffee.com/ivancarlos
|