-
Notifications
You must be signed in to change notification settings - Fork 10
Get GAGroup
Retrieve Group
Get-GAGroup [-GroupKey] <String> [-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Get-GAGroup [-All] [[-MaxResults] <Int32>] [[-Customer] <String>] [[-Domain] <String>]
[-StandardQueryParams <StandardQueryParameters>] [-GAuthId <String>] [-WhatIf] [-Confirm]
Get-GAGroup [[-UserName] <String>] [[-MaxResults] <Int32>] [[-Domain] <string>] [-GAuthId <string>] [-StandardQueryParams <StandardQueryParameters>] [-WhatIf] [-Confirm]
Retrieve Group
PS C:\> Get-GAGroup -Email $SomeGroupNameString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
PS C:\> Get-GAGroup -All
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
PS C:\> Get-GAGroup -UserName $SomeUserNameString
This automatically generated example serves to show the bare minimum required to call this Cmdlet.
Additional examples may be added, viewed and edited by users on the community wiki at the URL found in the related links.
Email or immutable Id of the group
Type: String
Parameter Sets: OneGroup
Aliases:
Required: True
Position: 0
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA switch to list all results.
Type: SwitchParameter
Parameter Sets: AllGroups
Aliases:
Required: True
Position: 1
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseEmail or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
Type: String
Parameter Sets: OneUser
Aliases:
Required: False
Position: 2
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseMaximum number of results to return. Default is 200
Type: Int32
Parameter Sets: OneUser, AllGroups
Aliases:
Required: False
Position: 3
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe unique ID for the customer's Google account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
Type: String
Parameter Sets: AllGroups
Aliases:
Required: False
Position: 4
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseThe domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead.
Type: String
Parameter Sets: AllGroups
Aliases:
Required: False
Position: 5
Default value:
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: FalseA Standard Query Parameters Object.
Type: StandardQueryParameters
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseThe GAuthId representing the gShell auth credentials this cmdlet should use to run.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value:
Accept pipeline input: False
Accept wildcard characters: FalseEmail or immutable Id of the group
Email or immutable Id of the user if only those groups are to be listed, the given user is a member of. If Id, it should match with id of user object
The unique ID for the customer's Google account. In case of a multi-domain account, to fetch all groups for a customer, fill this field instead of domain. As an account administrator, you can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource.
The domain name. Use this field to get fields from only one domain. To return all domains for a customer account, use the customer query parameter instead.
Part of the gShell Project, relating to the Google Directory API; see Related Links or use the -Online parameter.
News - Get Started - Cmdlet Index - FAQ - Discussion - Downloads