Get-GoogleDirectoryUserAlias

NAME Get-GoogleDirectoryUserAlias



SYNOPSIS

Retrieves all of the aliases for a GSuite user.





SYNTAX

Get-GoogleDirectoryUserAlias [-UserId] <String> -BearerToken <String> [-UseCompression] [<CommonParameters>]



Get-GoogleDirectoryUserAlias [-UserId] <String> [-ProfileLocation <String>] [-Persist] [-UseCompression]

[<CommonParameters>]





DESCRIPTION

This cmdlet retrieves all of the aliases for a GSuite user. All user aliases are returned in

alphabetical order. There is no page size such as the maxResults query string or pagination used

for the 'Retrieve all aliases' response. The returned aliases are the editable user email alias in

the account's primary domain or subdomains.





PARAMETERS

-UserId <String>

The Id of the user to get the aliases of. The UserId can be the user's primary email address, the unique user

id, or one of the user's alias email addresses.



Required? true

Position? 1

Default value

Accept pipeline input? true (ByValue)

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

System.String





OUTPUTS

System.Collections.Hashtable[]





NOTES





AUTHOR: Michael Haken

LAST UPDATE: 2/12/2018



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



PS C:\\>$Aliases = Get-GoogleDirectoryUserAlias -UserId liz@example.com -ClientId $Id -Persist



Gets all of the aliases for the user liz@example.com using stored client credentials and bypasses confirmation.











RELATED LINKS