Remove-SPUser
Applies to: SharePoint Server 2010, SharePoint Foundation 2010
Topic Last Modified: 2010-02-15
Removes a user from a Web site.
Remove-SPUser [-Identity] <SPUserPipeBind> -Web <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Confirm [<SwitchParameter>]] [-Group <SPGroupPipeBind>] [-WhatIf [<SwitchParameter>]]
The Remove-SPUser cmdlet specifies the identity and user group from which a user is to be removed. The Remove-SPUser cmdlet does not remove the user from Active Directory Domain Services (AD DS).
| Parameter | Required | Type | Description | ||
|---|---|---|---|---|---|
| Identity | Required | Microsoft.SharePoint.PowerShell.SPUserPipeBind | Specifies the GUID, the user name, or SPUser object to remove. The type must be a valid GUID of the user, in the form 1234-5678-9876-0987. | ||
| Web | Required | Microsoft.SharePoint.PowerShell.SPWebPipeBind | Specifies the name of the URL or GUID from which the user is to be removed. This parameter is needed only if the identity provided is the user name. The type must be a valid URL, in the form http://server_name, or a GUID, in the form 1234-5678-9807. | ||
| AssignmentCollection | Optional | Microsoft.SharePoint.PowerShell.SPAssignmentCollection | Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
| ||
| Confirm | Optional | System.Management.Automation.SwitchParameter | Prompts you for confirmation before executing the command. For more information, type the following command: get-help about_commonparameters | ||
| Group | Optional | Microsoft.SharePoint.PowerShell.SPGroupPipeBind | The user only gets removed from that group. Otherwise, the user gets removed from the site. | ||
| WhatIf | Optional | System.Management.Automation.SwitchParameter | Displays a message that describes the effect of the command instead of executing the command. For more information, type the following command: get-help about_commonparameters |
------------------EXAMPLE 1-----------------------
Remove-SPUser "Contoso \jdoe" -web http://test/web1
Get-SPWeb "http://test/web1" | Remove-SPUser "Contoso\jdoe"
This example removes the user (Contoso\jdoe) from the Web application http://test/web1.
------------------EXAMPLE 2-----------------------
Get-SPSite http://contoso.com |Get-SPWeb |Remove-SPUser "Contoso\jdoe"
This syntax removes the user (Contoso\Jdoe) from every Web in a site collection located at http://contoso.com.

Note