PSGSuite

2.1.0

## Summary

Powershell module wrapping Googles .NET SDKs in handy functions. Authentication is supported both with service account P12 keys as well as client_secrets.json to go through OAuth2.


## Prerequisites

In order to use this module, youll need to have the following:

* Powershell 4.0 or higher
* API Access Enabled in the Admin Console under Security
* Servic
## Summary

Powershell module wrapping Googles .NET SDKs in handy functions. Authentication is supported both with service account P12 keys as well as client_secrets.json to go through OAuth2.


## Prerequisites

In order to use this module, youll need to have the following:

* Powershell 4.0 or higher
* API Access Enabled in the Admin Console under Security
* Service Account key created and downloaded as a P12 key file
* API Client access allowed for the Service Account that will be used towards the API scopes that you intend to utilize
* Domain-Wide Delegation enabled for the service account


## Breaking Changes in 2.0.0

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

All other functions are either intact or have an alias included to support backwards compatibility in scripts.

## Tips & Tricks

* All functions support pre-acquired Access Tokens (using the AccessToken parameter).
* This is useful if you have a lot of recurring commands that leverage the same admin and scope(s) so you do not overrun the user API call quota, i.e. pulling info for a large set of emails in a user's inbox.
* If the access token is not pre-acquired, then the P12KeyPath, AppEmail, AdminEmail, CustomerID, and Domain parameters will default to reading from the PSGSuite config file (these can also be named in each function call, if preferred).
* If you plan on using this module on multiple computers or between multiple accounts on the same computer, you will need a new PSGoogle config created for each computer / user account pair.
Show more

Minimum PowerShell version

4.0

Installation Options

Copy and Paste the following command to install this package using PowerShellGet More Info

Install-Module -Name PSGSuite -RequiredVersion 2.1.0

Copy and Paste the following command to install this package using Microsoft.PowerShell.PSResourceGet More Info

Install-PSResource -Name PSGSuite -Version 2.1.0

You can deploy this package directly to Azure Automation. Note that deploying packages with dependencies will deploy all the dependencies to Azure Automation. Learn More

Manually download the .nupkg file to your system's default download location. Note that the file won't be unpacked, and won't include any dependencies. Learn More

Owners

Copyright

(c) SCRT HQ 2016-2018. All rights reserved.

Package Details

Author(s)

  • Nate Ferrell

Tags

Google GSuite Apps G Suite REST API Admin Directory User Goo.gl

Functions

Add-GSDrivePermission Add-GSEventAttendee Add-GSGmailFilter Add-GSGroupMember Add-GSPrincipalGroupMembership Add-GSUserAddress Add-GSUserExternalId Add-GSUserPhone Add-GSUserSchemaField Block-CoreCLREncryptionWarning Clear-GSSheet Convert-Base64 Convert-EpochToDate Copy-GSDriveFile Copy-GSSheet Export-GSDriveFile Export-GSSheet Get-GSActivityReport Get-GSCalendarEventList Get-GSDataTransferApplication Get-GSDriveFile Get-GSDriveFileList Get-GSDriveFileUploadStatus Get-GSDrivePermission Get-GSGmailFilter Get-GSGmailForwardingAddress Get-GSGmailLabel Get-GSGmailMessage Get-GSGmailMessageList Get-GSGroup Get-GSGroupListPrivate Get-GSGroupMember Get-GSGroupMemberListPrivate Get-GSGroupSettings Get-GSMobileDevice Get-GSOrganizationalUnit Get-GSOrganizationalUnitListPrivate Get-GSResource Get-GSResourceListPrivate Get-GSSheetInfo Get-GSShortUrl Get-GSShortUrlListPrivate Get-GSTeamDrive Get-GSUsageReport Get-GSUser Get-GSUserASP Get-GSUserASPListPrivate Get-GSUserLicense Get-GSUserLicenseListPrivate Get-GSUserListPrivate Get-GSUserPhoto Get-GSUserSchema Get-GSUserSchemaListPrivate Get-GSUserToken Get-GSUserTokenListPrivate Get-GSUserVerificationCodes Get-MimeType Get-PSGSuiteConfig Import-GoogleSDK Import-GSSheet Import-SpecificConfiguration New-GoogleService New-GSCalendarEvent New-GSDriveFile New-GSGroup New-GSOrganizationalUnit New-GSResource New-GSSheet New-GSShortUrl New-GSTeamDrive New-GSUser New-GSUserSchema New-GSUserVerificationCodes New-MimeMessage Out-TruncatedString Read-MimeMessage Read-Prompt Remove-GSGmailFilter Remove-GSGmailMessage Remove-GSGroup Remove-GSGroupMember Remove-GSMobileDevice Remove-GSOrganizationalUnit Remove-GSPrincipalGroupMembership Remove-GSResource Remove-GSTeamDrive Remove-GSUser Remove-GSUserASP Remove-GSUserLicense Remove-GSUserSchema Remove-GSUserToken Restore-GSGmailMessage Restore-GSUser Revoke-GSUserVerificationCodes Send-GmailMessage Set-GSGroupSettings Set-GSUserLicense Set-GSUserSchema Set-PSGSuiteConfig Show-PSGSuiteConfig Start-GSDataTransfer Start-GSDriveFileUpload Switch-PSGSuiteConfig Test-FileLock ThrowTerm Unblock-CoreCLREncryptionWarning Update-GSDriveFile Update-GSGroupSettings Update-GSOrganizationalUnit Update-GSResource Update-GSTeamDrive Update-GSUser Update-GSUserLicense Update-GSUserSchema Watch-GSDriveUpload Write-InlineProgress

PSEditions

Core

Dependencies

FileList

Version History

Version Downloads Last updated
2.36.4 72,166 3/20/2020
2.36.3 51 3/20/2020
2.36.2 250 3/3/2020
2.36.1 43 3/2/2020
2.36.0 75 2/28/2020
2.35.1 583 12/29/2019
2.35.0 37 12/29/2019
2.34.0 584 11/3/2019
2.33.2 400 10/7/2019
2.33.1 32 10/6/2019
2.33.0 125 9/27/2019
2.32.3 174 9/19/2019
2.32.2 99 9/15/2019
2.32.1 40 9/14/2019
2.32.0 66 9/13/2019
2.31.1 171 8/30/2019
2.31.0 492 7/31/2019
2.30.2 160 7/18/2019
2.30.1 50 7/17/2019
2.30.0 39 7/17/2019
2.29.0 234 6/28/2019
2.28.2 288 6/5/2019
2.28.1 61 6/1/2019
2.28.0 42 5/31/2019
2.27.0 166 5/15/2019
2.26.4 152 4/26/2019
2.26.3 32 4/26/2019
2.26.2 57 4/25/2019
2.26.1 171 4/7/2019
2.26.0 100 3/30/2019
2.25.3 85 3/26/2019
2.25.2 38 3/26/2019
2.25.1 31 3/26/2019
2.25.0 65 3/20/2019
2.24.0 1,474 3/6/2019
2.23.2 34 3/5/2019
2.23.1 33 3/5/2019
2.23.0 83 2/27/2019
2.22.4 202 2/4/2019
2.22.3 125 1/15/2019
2.22.2 33 1/15/2019
2.22.1 182 12/29/2018
2.22.0 44 12/27/2018
2.21.3 46 12/26/2018
2.21.2 34 12/24/2018
2.21.1 39 12/21/2018
2.21.0 40 12/19/2018
2.20.2 166 11/25/2018
2.20.1 31 11/25/2018
2.20.0 67 11/20/2018
2.19.0 71 11/14/2018
2.18.1 61 11/8/2018
2.18.0 57 11/6/2018
2.17.2 83 10/25/2018
2.17.1 62 10/23/2018
2.17.0 32 10/23/2018
2.16.1 80 10/14/2018
2.16.0 32 10/14/2018
2.15.4 41 10/12/2018
2.15.3 42 10/10/2018
2.15.2 45 10/9/2018
2.15.1 64 10/5/2018
2.15.0 48 10/3/2018
2.14.1 43 10/2/2018
2.14.0 45 9/28/2018
2.13.2 159 8/31/2018
2.13.1 123 8/24/2018
2.13.0 115 8/15/2018
2.12.1 81 7/26/2018
2.12.0 75 7/13/2018
2.11.0 73 7/6/2018
2.10.2 37 7/5/2018
2.10.1 29 7/4/2018
2.10.0 35 7/3/2018
2.9.0 23 7/1/2018
2.8.1 23 6/29/2018
2.8.0 23 6/27/2018
2.7.2 35 6/22/2018
2.7.1 23 6/21/2018
2.7.0 35 6/17/2018
2.6.3 39 6/9/2018
2.6.2 92 5/18/2018
2.6.1 24 5/17/2018
2.6.0 43 5/8/2018
2.5.4 28 5/4/2018
2.5.3 18 5/4/2018
2.5.2 26 5/3/2018
2.5.1 46 5/1/2018
2.5.0 34 4/30/2018
2.4.0 126 4/9/2018
2.3.0 33 4/9/2018
2.2.1 58 3/28/2018
2.2.0 82 3/17/2018
2.1.7 48 3/10/2018
2.1.6 47 3/1/2018
2.1.5 50 2/20/2018
2.1.4 43 2/16/2018
2.1.3 35 2/16/2018
2.1.2 51 2/10/2018
2.1.1 32 2/10/2018
2.1.0 (current version) 32 2/10/2018
2.0.3 39 2/9/2018
2.0.2 47 2/6/2018
2.0.1 39 2/5/2018
2.0.0 43 2/5/2018
1.2.1 415 3/12/2017
1.2.0 37 3/12/2017
1.1.5 42 2/27/2017
1.1.2 35 2/22/2017
1.1.1 40 2/12/2017
1.1.0 34 2/12/2017
1.0.6 36 2/8/2017
1.0.5 33 2/8/2017
Show less