Public/Get-GSUserList.ps1
|
function Get-GSUserList { <# .Synopsis Gets the user list for a given account in Google Apps .DESCRIPTION Retrieves the full user list for the entire account. Accepts standard Google queries as a string or array of strings. .EXAMPLE Get-GSUserList -MaxResults 300 -Query "orgUnitPath=/Users","email=domain.user2@domain.com" .EXAMPLE Get-GSUserList -Verbose #> [cmdletbinding()] Param ( [parameter(Mandatory=$false)] [String[]] $Query, [parameter(Mandatory=$false)] [ValidateScript({[int]$_ -le 500 -and [int]$_ -ge 1})] [Int] $PageSize="500", [parameter(Mandatory=$false)] [ValidateSet("Email","GivenName","FamilyName")] [String] $OrderBy, [parameter(Mandatory=$false)] [ValidateSet("Ascending","Descending")] [String] $SortOrder, [parameter(Mandatory=$false)] [String] $AccessToken, [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String] $P12KeyPath = $Script:PSGSuite.P12KeyPath, [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String] $AppEmail = $Script:PSGSuite.AppEmail, [parameter(Mandatory=$false)] [ValidateNotNullOrEmpty()] [String] $AdminEmail = $Script:PSGSuite.AdminEmail, [parameter(Mandatory=$false)] [String] $CustomerID=$Script:PSGSuite.CustomerID, [parameter(Mandatory=$false)] [String] $Domain=$Script:PSGSuite.Domain, [parameter(Mandatory=$false)] [ValidateSet("Domain","CustomerID")] [String] $Preference=$Script:PSGSuite.Preference ) if (!$AccessToken) { $AccessToken = Get-GSToken -P12KeyPath $P12KeyPath -Scopes "https://www.googleapis.com/auth/admin.directory.user.readonly" -AppEmail $AppEmail -AdminEmail $AdminEmail } $header = @{ Authorization="Bearer $AccessToken" } if ($Preference -eq "Domain") { $URI = "https://www.googleapis.com/admin/directory/v1/users?domain=$Domain&projection=full" } elseif($Preference -eq "CustomerID") { $URI = "https://www.googleapis.com/admin/directory/v1/users?customer=$CustomerID&projection=full" } else { $URI = "https://www.googleapis.com/admin/directory/v1/users?customer=my_customer&projection=full" } if ($PageSize){$URI = "$URI&maxResults=$PageSize"} if ($OrderBy){$URI = "$URI&orderBy=$OrderBy"} if ($SortOrder){$URI = "$URI&sortOrder=$SortOrder"} if ($Query) { $Query = $($Query -join " ") $URI = "$URI&query=$Query" } try { Write-Verbose "Constructed URI: $URI" $response = @() [int]$i=1 do { if ($i -eq 1) { $result = Invoke-RestMethod -Method Get -Uri $URI -Headers $header -Verbose:$false } else { $result = Invoke-RestMethod -Method Get -Uri "$URI&pageToken=$pageToken" -Headers $header -Verbose:$false } $response += $result.users | ForEach-Object {if($_.kind -like "*#*"){$_.PSObject.TypeNames.Insert(0,$(Convert-KindToType -Kind $_.kind));$_}else{$_}} $returnSize = $result.users.Count $pageToken="$($result.nextPageToken)" [int]$retrieved = ($i + $result.users.Count) - 1 Write-Verbose "Retrieved $retrieved users..." [int]$i = $i + $result.users.Count } until ($returnSize -lt $PageSize) } catch { try { $result = $_.Exception.Response.GetResponseStream() $reader = New-Object System.IO.StreamReader($result) $reader.BaseStream.Position = 0 $reader.DiscardBufferedData() $resp = $reader.ReadToEnd() $response = $resp | ConvertFrom-Json | Select-Object @{N="Error";E={$Error[0]}},@{N="Code";E={$_.error.Code}},@{N="Message";E={$_.error.Message}},@{N="Domain";E={$_.error.errors.domain}},@{N="Reason";E={$_.error.errors.reason}} Write-Error "$(Get-HTTPStatus -Code $response.Code): $($response.Domain) / $($response.Message) / $($response.Reason)" return } catch { Write-Error $resp return } } return $response } |