< Back

Get-GoogleDirectoryGroupAlias

Mon Jan 13, 2020 10:31 pm

NAME Get-GoogleDirectoryGroupAlias



SYNOPSIS

Gets all GSuite group aliases for a specified group.





SYNTAX

Get-GoogleDirectoryGroupAlias [-GroupKey] <String> -BearerToken <String> [-UseCompression] [<CommonParameters>]



Get-GoogleDirectoryGroupAlias [-GroupKey] <String> [-ProfileLocation <String>] [-Persist] [-UseCompression]

[<CommonParameters>]





DESCRIPTION

This cmdlet gets all of the aliases assigned to the specified group.





PARAMETERS

-GroupKey <String>

The unique Id of the group.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-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



-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.Collection.Hashtable[]



Each hashtable will follow this format:



{

"kind": "admin#directory#alias",

"id": string,

"etag": etag,

"primaryEmail": string,

"alias": string

}





NOTES





AUTHOR: Michael Haken

LAST UPDATE: 2/6/2018



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>$Aliases = Get-GoogleDirectoryGroupAlias -GroupKey NNN -ClientId $Id -Persist



Gets a list of all group aliases for the group identified by NNN.











RELATED LINKS