SCRT-HQ / PSGSuite

Powershell module for Google / G Suite API calls wrapped in handy functions. Authentication is established using a service account via P12 key to negate the consent popup and allow for greater handsoff automation capabilities

PSGSuite

              

              

---

Documentation

Check out PSGSuite.io for PSGSuite documentation, including initial setup help as well as function help!

Contributing

Interested in helping out with PSGSuite development? Please check out our Contribution Guidelines!

Building the module locally to test changes is as easy as running the build.ps1 file in the root of the repo. This will compile the module with your changes and import the newly compiled module at the end by default.

Want to run the Pester tests locally? Pass Test as the value to the Task script parameter like so:

.\build.ps1 -Task Test

Code of Conduct

Please adhere to our Code of Conduct when interacting with this repo.

License

Apache 2.0

Changelog

Full CHANGELOG here

---

2.0.0 - Changes

New Functionality

• PowerShell Core support for cross-platform functionality
• P12 Keys (service accounts) and client_secrets.json (OAuth) are both now supported
• All Drive functions now support Team Drives
• Get-GSGmailMessage can now save message attachments to a local path
• File uploads to Drive are now supported (including recursive folder uploads!)

Breaking Changes in 2.0.0

Gmail Delegation Management Removed

The Gmail API does not yet support handling inbox delegation. The functionality addition has been pushed back again until Q3 of 2018. Once the Gmail API supports inbox delegation, those functions will be added.

Delegation functions have been re-added to PSGSuite as of v2.4.0! Update now to get all the goodness of v2 + delegation commands!

Functions Removed

Please note that not all functions were ported to PSGSuite 2.0.0 due to restrictions within the .NET SDK and deprecated API calls. Here is the list of functions no longer existing in PSGSuite as of 2.0.0:

• Get-GSToken: no need for this as the keys are being consumed by Googles Auth SDK directly now, which makes Access/Refresh tokens non-existent for P12 Key service accounts and token management is handled automatically
• Revoke-GSToken: same here, no longer needed due to auth service changes
• Start-PSGSuiteConfigWizard: no longer supported as WPF is not compatible outside of Windows

Functions Aliased

All other functions are either intact or have an alias included to support backwards compatibility in scripts. Full list of aliases:

Alias	Maps To
Add-GSDriveFilePermissions	Add-GSDrivePermission
Export-PSGSuiteConfiguration	Set-PSGSuiteConfig
Get-GSCalendarEventList	Get-GSCalendarEvent
Get-GSCalendarResourceList	Get-GSResourceList
Get-GSDataTransferApplicationList	Get-GSDataTransferApplication
Get-GSDriveFileInfo	Get-GSDriveFile
Get-GSDriveFilePermissionsList	Get-GSDrivePermission
Get-GSGmailDelegates	Get-GSGmailDelegate
Get-GSGmailFilterList	Get-GSGmailFilter
Get-GSGmailLabelList	Get-GSGmailLabel
Get-GSGmailMessageInfo	Get-GSGmailMessage
Get-GSGmailSendAsSettings	Get-GSGmailSendAsAlias
Get-GSGmailSignature	Get-GSGmailSendAsAlias
Get-GSGroupList	Get-GSGroup
Get-GSGroupMemberList	Get-GSGroupMember
Get-GSMobileDeviceList	Get-GSMobileDevice
Get-GSOrganizationalUnitList	Get-GSOrganizationalUnit
Get-GSOrgUnit	Get-GSOrganizationalUnit
Get-GSOrgUnitList	Get-GSOrganizationalUnit
Get-GSOU	Get-GSOrganizationalUnit
Get-GSResourceList	Get-GSResource
Get-GSShortURLInfo	Get-GSShortURL
Get-GSTeamDrive	Get-GSDrive
Get-GSTeamDrivesList	Get-GSDrive
Get-GSUserASPList	Get-GSUserASP
Get-GSUserLicenseInfo	Get-GSUserLicense
Get-GSUserLicenseList	Get-GSUserLicense
Get-GSUserList	Get-GSUser
Get-GSUserSchemaInfo	Get-GSUserSchema
Get-GSUserSchemaList	Get-GSUserSchema
Get-GSUserTokenList	Get-GSUserToken
Import-PSGSuiteConfiguration	Get-PSGSuiteConfig
Move-GSGmailMessageToTrash	Remove-GSGmailMessage
New-GSCalendarResource	New-GSResource
Remove-GSGmailMessageFromTrash	Restore-GSGmailMessage
Set-PSGSuiteDefaultDomain	Switch-PSGSuiteConfig
Switch-PSGSuiteDomain	Switch-PSGSuiteConfig
Update-GSCalendarResource	Update-GSResource
Update-GSGmailSendAsSettings	Update-GSGmailSendAsAlias
Update-GSSheetValue	Export-GSSheet

Most recent changes

Full CHANGELOG here

2.36.4 - 2020-03-20

• Issue #270
  • Corrected inaccurate warning that no licenses were found for a user when using the CheckAll switch on Get-GSUserLicense.

2.36.3 - 2020-03-20

• Issue #270
  • Added CheckAll switch parameter to Get-GSUserLicense
  • Updated User parameter aliases for all *-GSUserLicense functions to include UserId for better pipeline support.
• Miscellaneous
  • Updated GitHub Release section in psake.ps1 to POST the release to the Org URL due to failures.

2.36.2 - 2020-03-02

• Issue #263
  • Cleaned up decryption logic for encrypted config.

2.36.1 - 2020-03-02

• Issue #263
  • Fixed [SecureString] decryption on Unix machines running PowerShell 7 (found additional bugs)
  • Migrated private Encrypt and Decrypt to EncryptionHelpers.ps1 in the Private folder to allow a single place to update.

2.36.0 - 2020-02-28

• PR #255 - Thanks, @FISHMANPET!
  • Added support for [ScriptBlock] values on the config, allowing you to provide a script to run that will pull in a configuration value (vs embedded the value directly on the config)
• PR #255 - Thanks, @vaskotoo!
  • Added support for an array of Users on Get-GSGmailMessageList
• PR #261 - Thanks, @Foggy2!
  • Added support for all license types including undocumented ones.
  • Closed out Issue #252 as well.
• PR #262 - Thanks, @nwls-hermesj!
  • Added support for pipeline input of Drive file objects to Remove-GSDriveFile.
• Issue #256
  • Cleaned up docs on Send-GSChatMessage.
• Issue #258
  • Removed URL Shortener functions due to Google deprecation.
• Issue #263
  • Fixed [SecureString] decryption on Unix machines running PowerShell 7
• Miscellaneous
  • Removed the Tasks API functions. Google has not pushed an update to the Tasks .NET SDK in over 2 months, so it is now behind the current release versions of the core Google.Apis assemblies, resulting in failure to import.