< Back
Remove-GoogleDirectoryUserAlias
Post
NAME Remove-GoogleDirectoryUserAlias
SYNOPSIS
Deletes an alias for a GSuite user.
SYNTAX
Remove-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> -BearerToken <String> [<CommonParameters>]
Remove-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> [-ProfileLocation <String>] [-Persist]
[<CommonParameters>]
DESCRIPTION
This cmdlet deletes a specified alias for a GSuite user.
PARAMETERS
-UserId <String>
The Id of the user to delete 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 alias to delete. This parameter is the alias' email address that is being deleted.
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
<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
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-GoogleDirectoryUserAlias -UserId liz@example.com -UserAlias elizabeth@example.com -ClientId $Id
-Persist -Force
Deletes the elizabeth@example.com alias for the user liz@example.com using stored client credentials and bypasses
confirmation.
RELATED LINKS
SYNOPSIS
Deletes an alias for a GSuite user.
SYNTAX
Remove-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> -BearerToken <String> [<CommonParameters>]
Remove-GoogleDirectoryUserAlias [-UserId] <String> [-UserAlias] <String> [-ProfileLocation <String>] [-Persist]
[<CommonParameters>]
DESCRIPTION
This cmdlet deletes a specified alias for a GSuite user.
PARAMETERS
-UserId <String>
The Id of the user to delete 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 alias to delete. This parameter is the alias' email address that is being deleted.
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
<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
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Remove-GoogleDirectoryUserAlias -UserId liz@example.com -UserAlias elizabeth@example.com -ClientId $Id
-Persist -Force
Deletes the elizabeth@example.com alias for the user liz@example.com using stored client credentials and bypasses
confirmation.
RELATED LINKS