< Back
Get-GoogleDirectoryGroupList
Post
NAME Get-GoogleDirectoryGroupList
SYNOPSIS
Gets a list of GSuite groups.
SYNTAX
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] -CustomerId <String> [-UseCompression]
[<CommonParameters>]
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] -Domain <String> [-UseCompression]
[<CommonParameters>]
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] [-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] -CustomerId <String>
[-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] -Domain <String>
[-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] [-UseCompression]
[<CommonParameters>]
DESCRIPTION
This cmdlet retrieves details about GSuite groups based on a customer id or domain id. The cmdlet defaults to using
my_customer as the customer id, which uses the customer id of the user making the API call.
PARAMETERS
-BearerToken <String>
The bearer token to use to authenticate the request.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProfileLocation <String>
The location where stored credentials are located. If this is not specified, the default location will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Persist [<SwitchParameter>]
Indicates that the newly retrieved token(s) or refreshed token and associated client data like client secret
are persisted to disk.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MaxResults <UInt32>
The maximum number of results returned in a single call. Specifying a non-zero value for this parameter will
page
the results so that multiple HTTP calls are made to retrieve all of the results.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Domain <String>
Retrieves all groups for this sub-domain.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerId <String>
Retrieves all groups in the account for this customer. This is the default and uses the value my_customer,
which
represents the customer id of the administrator making the API call.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseCompression [<SwitchParameter>]
If specified, the returned data is compressed using gzip.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Collections.Hashtable[]
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/6/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Groups = Get-GoogleDirectoryGroupList -ClientId $Id -Persist -UseCompression
Gets a listing of all of the groups for the admin using the cmdlet. The results are returned using gzip to minimize
bandwidth utilization.
RELATED LINKS
SYNOPSIS
Gets a list of GSuite groups.
SYNTAX
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] -CustomerId <String> [-UseCompression]
[<CommonParameters>]
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] -Domain <String> [-UseCompression]
[<CommonParameters>]
Get-GoogleDirectoryGroupList -BearerToken <String> [-MaxResults <UInt32>] [-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] -CustomerId <String>
[-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] -Domain <String>
[-UseCompression] [<CommonParameters>]
Get-GoogleDirectoryGroupList [-ProfileLocation <String>] [-Persist] [-MaxResults <UInt32>] [-UseCompression]
[<CommonParameters>]
DESCRIPTION
This cmdlet retrieves details about GSuite groups based on a customer id or domain id. The cmdlet defaults to using
my_customer as the customer id, which uses the customer id of the user making the API call.
PARAMETERS
-BearerToken <String>
The bearer token to use to authenticate the request.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ProfileLocation <String>
The location where stored credentials are located. If this is not specified, the default location will be used.
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Persist [<SwitchParameter>]
Indicates that the newly retrieved token(s) or refreshed token and associated client data like client secret
are persisted to disk.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-MaxResults <UInt32>
The maximum number of results returned in a single call. Specifying a non-zero value for this parameter will
page
the results so that multiple HTTP calls are made to retrieve all of the results.
Required? false
Position? named
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-Domain <String>
Retrieves all groups for this sub-domain.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-CustomerId <String>
Retrieves all groups in the account for this customer. This is the default and uses the value my_customer,
which
represents the customer id of the administrator making the API call.
Required? true
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-UseCompression [<SwitchParameter>]
If specified, the returned data is compressed using gzip.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
OUTPUTS
System.Collections.Hashtable[]
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/6/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>$Groups = Get-GoogleDirectoryGroupList -ClientId $Id -Persist -UseCompression
Gets a listing of all of the groups for the admin using the cmdlet. The results are returned using gzip to minimize
bandwidth utilization.
RELATED LINKS