PSGSuite

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

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

Install-PSResource -Name PSGSuite -Version 2.21.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

GSuite Google Apps API Drive Gmail Admin Automation

Functions

Add-GSCalendarSubscription Add-GSChatButton Add-GSChatCard Add-GSChatCardAction Add-GSChatCardSection Add-GSChatImage Add-GSChatKeyValue Add-GSChatOnClick Add-GSChatTextParagraph Add-GSCourseParticipant Add-GSDocContent Add-GSDrivePermission Add-GSEventAttendee Add-GSGmailDelegate Add-GSGmailFilter Add-GSGmailForwardingAddress Add-GSGroupMember Add-GSPrincipalGroupMembership Add-GSUserAddress Add-GSUserEmail Add-GSUserExternalId Add-GSUserOrganization Add-GSUserPhone Add-GSUserRelation Add-GSUserSchemaField Block-CoreCLREncryptionWarning Clear-GSSheet Clear-GSTasklist Compare-ModuleVersion Confirm-GSCourseInvitation Copy-GSDriveFile Copy-GSSheet Export-GSDriveFile Export-GSSheet Get-GSActivityReport Get-GSAdminRole Get-GSAdminRoleAssignment Get-GSCalendarACL Get-GSCalendarEvent Get-GSCalendarSubscription Get-GSChatConfig Get-GSChatMember Get-GSChatMessage Get-GSChatSpace Get-GSClassroomUserProfile Get-GSContactList Get-GSCourse Get-GSCourseAlias Get-GSCourseInvitation Get-GSCourseParticipant Get-GSDataTransferApplication Get-GSDocContent Get-GSDriveFile Get-GSDriveFileList Get-GSDriveFileUploadStatus Get-GSDrivePermission Get-GSDriveProfile Get-GSGmailAutoForwardingSettings Get-GSGmailDelegate Get-GSGmailFilter Get-GSGmailForwardingAddress Get-GSGmailImapSettings Get-GSGmailLabel Get-GSGmailMessage Get-GSGmailMessageList Get-GSGmailPopSettings Get-GSGmailProfile Get-GSGmailSMIMEInfo Get-GSGmailVacationSettings Get-GSGroup Get-GSGroupAlias Get-GSGroupMember Get-GSGroupSettings Get-GSMobileDevice Get-GSOrganizationalUnit Get-GSResource Get-GSSheetInfo Get-GSShortUrl Get-GSStudentGuardian Get-GSStudentGuardianInvitation Get-GSTask Get-GSTasklist Get-GSTeamDrive Get-GSToken Get-GSUsageReport Get-GSUser Get-GSUserAlias Get-GSUserASP Get-GSUserLicense Get-GSUserPhoto Get-GSUserSchema Get-GSUserToken Get-GSUserVerificationCodes Get-PSGSuiteConfig Import-GSSheet Move-GSTask New-GoogleService New-GSAdminRole New-GSAdminRoleAssignment New-GSCalendarACL New-GSCalendarEvent New-GSCourse New-GSCourseAlias New-GSCourseInvitation New-GSDriveFile New-GSGmailLabel New-GSGmailSMIMEInfo New-GSGroup New-GSGroupAlias New-GSOrganizationalUnit New-GSResource New-GSSheet New-GSShortUrl New-GSStudentGuardianInvitation New-GSTask New-GSTasklist New-GSTeamDrive New-GSUser New-GSUserAlias New-GSUserSchema New-GSUserVerificationCodes Remove-GSAdminRole Remove-GSAdminRoleAssignment Remove-GSCalendarEvent Remove-GSCalendarSubscription Remove-GSChatMessage Remove-GSContact Remove-GSCourse Remove-GSCourseAlias Remove-GSCourseInvitation Remove-GSCourseParticipant Remove-GSDrivePermission Remove-GSGmailDelegate Remove-GSGmailFilter Remove-GSGmailLabel Remove-GSGmailMessage Remove-GSGmailSMIMEInfo Remove-GSGroup Remove-GSGroupAlias Remove-GSGroupMember Remove-GSMobileDevice Remove-GSOrganizationalUnit Remove-GSPrincipalGroupMembership Remove-GSResource Remove-GSStudentGuardian Remove-GSTask Remove-GSTasklist Remove-GSTeamDrive Remove-GSUser Remove-GSUserAlias Remove-GSUserASP Remove-GSUserLicense Remove-GSUserPhoto Remove-GSUserSchema Remove-GSUserToken Restore-GSGmailMessage Restore-GSUser Revoke-GSUserVerificationCodes Send-GmailMessage Send-GSChatMessage Set-GSDocContent Set-GSGroupSettings Set-GSUserLicense Set-GSUserSchema Set-PSGSuiteConfig Show-PSGSuiteConfig Start-GSDataTransfer Start-GSDriveFileUpload Switch-PSGSuiteConfig Sync-GSUserCache Unblock-CoreCLREncryptionWarning Update-GSAdminRole Update-GSCalendarEvent Update-GSChatMessage Update-GSCourse Update-GSDriveFile Update-GSGmailAutoForwardingSettings Update-GSGmailImapSettings Update-GSGmailLabel Update-GSGmailMessageLabels Update-GSGmailPopSettings Update-GSGmailVacationSettings Update-GSGroupMember Update-GSGroupSettings Update-GSMobileDevice Update-GSOrganizationalUnit Update-GSResource Update-GSTask Update-GSTasklist Update-GSTeamDrive Update-GSUser Update-GSUserLicense Update-GSUserPhoto Update-GSUserSchema Watch-GSDriveUpload

PSEditions

Core Desktop

Dependencies

FileList

  • PSGSuite.nuspec
  • PSGSuite.psd1
  • PSGSuite.psm1
  • lib\net45\BouncyCastle.Crypto.dll
  • lib\net45\Google.Apis.Admin.DataTransfer.datatransfer_v1.dll
  • lib\net45\Google.Apis.Admin.Directory.directory_v1.dll
  • lib\net45\Google.Apis.Admin.Reports.reports_v1.dll
  • lib\net45\Google.Apis.Auth.dll
  • lib\net45\Google.Apis.Auth.PlatformServices.dll
  • lib\net45\Google.Apis.Calendar.v3.dll
  • lib\net45\Google.Apis.Classroom.v1.dll
  • lib\net45\Google.Apis.Core.dll
  • lib\net45\Google.Apis.dll
  • lib\net45\Google.Apis.Drive.v3.dll
  • lib\net45\Google.Apis.Gmail.v1.dll
  • lib\net45\Google.Apis.Groupssettings.v1.dll
  • lib\net45\Google.Apis.HangoutsChat.v1.dll
  • lib\net45\Google.Apis.Licensing.v1.dll
  • lib\net45\Google.Apis.Oauth2.v2.dll
  • lib\net45\Google.Apis.PlatformServices.dll
  • lib\net45\Google.Apis.Script.v1.dll
  • lib\net45\Google.Apis.Sheets.v4.dll
  • lib\net45\Google.Apis.Tasks.v1.dll
  • lib\net45\Google.Apis.Urlshortener.v1.dll
  • lib\net45\MimeKit.dll
  • lib\net45\Newtonsoft.Json.dll
  • lib\netstandard1.3\BouncyCastle.Crypto.dll
  • lib\netstandard1.3\Google.Apis.Admin.DataTransfer.datatransfer_v1.dll
  • lib\netstandard1.3\Google.Apis.Admin.Directory.directory_v1.dll
  • lib\netstandard1.3\Google.Apis.Admin.Reports.reports_v1.dll
  • lib\netstandard1.3\Google.Apis.Auth.dll
  • lib\netstandard1.3\Google.Apis.Auth.PlatformServices.dll
  • lib\netstandard1.3\Google.Apis.Calendar.v3.dll
  • lib\netstandard1.3\Google.Apis.Classroom.v1.dll
  • lib\netstandard1.3\Google.Apis.Core.dll
  • lib\netstandard1.3\Google.Apis.dll
  • lib\netstandard1.3\Google.Apis.Drive.v3.dll
  • lib\netstandard1.3\Google.Apis.Gmail.v1.dll
  • lib\netstandard1.3\Google.Apis.Groupssettings.v1.dll
  • lib\netstandard1.3\Google.Apis.HangoutsChat.v1.dll
  • lib\netstandard1.3\Google.Apis.Licensing.v1.dll
  • lib\netstandard1.3\Google.Apis.Oauth2.v2.dll
  • lib\netstandard1.3\Google.Apis.Script.v1.dll
  • lib\netstandard1.3\Google.Apis.Sheets.v4.dll
  • lib\netstandard1.3\Google.Apis.Tasks.v1.dll
  • lib\netstandard1.3\Google.Apis.Urlshortener.v1.dll
  • lib\netstandard1.3\MimeKit.dll
  • lib\netstandard1.3\Newtonsoft.Json.dll

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 (current version) 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 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