< Back
Restore-GoogleDirectoryUser
Post
NAME Restore-GoogleDirectoryUser
SYNOPSIS
Restores a deleted GSuite user.
SYNTAX
Restore-GoogleDirectoryUser [-UserId] <String> -BearerToken <String> [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
Restore-GoogleDirectoryUser [-UserId] <String> [-ProfileLocation <String>] [-Persist] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet restores a deleted GSuite user that has been deleted within the last 5 days.
PARAMETERS
-UserId <String>
The Id of the user to restore. The UserId is the unique user id found in the response of the retrieve
users deleted within the past 5 days operation. The user's primary email address or one of the user's
alias email addresses cannot be used in the UserId for this operation.
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
-Force [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
None
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Restore-GoogleDirectoryUser -UserId 12309329403209438205 -ClientId $Id -Persist -Force
This restores (undeletes) the user 12309329403209438205 using stored client credentials and bypasses confirmation.
RELATED LINKS
SYNOPSIS
Restores a deleted GSuite user.
SYNTAX
Restore-GoogleDirectoryUser [-UserId] <String> -BearerToken <String> [-Force] [-WhatIf] [-Confirm]
[<CommonParameters>]
Restore-GoogleDirectoryUser [-UserId] <String> [-ProfileLocation <String>] [-Persist] [-Force] [-WhatIf]
[-Confirm] [<CommonParameters>]
DESCRIPTION
This cmdlet restores a deleted GSuite user that has been deleted within the last 5 days.
PARAMETERS
-UserId <String>
The Id of the user to restore. The UserId is the unique user id found in the response of the retrieve
users deleted within the past 5 days operation. The user's primary email address or one of the user's
alias email addresses cannot be used in the UserId for this operation.
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
-Force [<SwitchParameter>]
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-WhatIf [<SwitchParameter>]
Required? false
Position? named
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Confirm [<SwitchParameter>]
Required? false
Position? named
Default value
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
None
NOTES
AUTHOR: Michael Haken
LAST UPDATE: 2/12/2018
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Restore-GoogleDirectoryUser -UserId 12309329403209438205 -ClientId $Id -Persist -Force
This restores (undeletes) the user 12309329403209438205 using stored client credentials and bypasses confirmation.
RELATED LINKS