< Back
New-GoogleDirectoryUserAlias
Post
NAME New-GoogleDirectoryUserAlias
SYNOPSIS
Creates a new alias for a GSuite user.
SYNTAX
New-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> -BearerToken <String> [-PassThru]
[-UseCompression] [<CommonParameters>]
New-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> [-ProfileLocation <String>] [-Persist]
[-PassThru] [-UseCompression] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new alias for a GSuite user. The maximum number of aliases per user is 30.
PARAMETERS
-UserId <String>
The Id of the user to create an alias for. 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? false
Accept wildcard characters? false
-UserAlias <String>
The email alias to create for the user, like elizabeth@example.com.
Required? true
Position? 2
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
-PassThru [<SwitchParameter>]
If specified the new user alias is returned to the pipeline.
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
None or System.Collections.Hashtable
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-GoogleDirectoryUserAlias -UserId liz@example.com -UserAlias elizabeth@example.com -ClientId $Id -Persist
This creates a new alias, elizabeth@example.com, for the user liz@example.com using stored client credentials and
bypasses confirmation.
RELATED LINKS
SYNOPSIS
Creates a new alias for a GSuite user.
SYNTAX
New-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> -BearerToken <String> [-PassThru]
[-UseCompression] [<CommonParameters>]
New-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> [-ProfileLocation <String>] [-Persist]
[-PassThru] [-UseCompression] [<CommonParameters>]
DESCRIPTION
This cmdlet creates a new alias for a GSuite user. The maximum number of aliases per user is 30.
PARAMETERS
-UserId <String>
The Id of the user to create an alias for. 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? false
Accept wildcard characters? false
-UserAlias <String>
The email alias to create for the user, like elizabeth@example.com.
Required? true
Position? 2
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
-PassThru [<SwitchParameter>]
If specified the new user alias is returned to the pipeline.
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
None or System.Collections.Hashtable
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>New-GoogleDirectoryUserAlias -UserId liz@example.com -UserAlias elizabeth@example.com -ClientId $Id -Persist
This creates a new alias, elizabeth@example.com, for the user liz@example.com using stored client credentials and
bypasses confirmation.
RELATED LINKS