Export (0) Print
Expand All

Get-SPUser

 

Applies to: SharePoint Server 2013 Enterprise, SharePoint Foundation 2013

Topic Last Modified: 2014-03-04

Returns the user account or accounts that match a given search criteria.

Get-SPUser [[-Identity] <SPUserPipeBind>] -Web <SPWebPipeBind> [-AssignmentCollection <SPAssignmentCollection>] [-Group <SPGroupPipeBind>] [-Limit <String>]

The Get-SPUser cmdlet returns all SharePoint user accounts that match the scope given by the Identity, Web, or Group parameters.

The Identity parameter can use the alias of a user for returning exact matches. However, a scope must be provided if the Get-SPUser cmdlet is to work.

 

Parameter Required Type Description

Identity

Optional

Microsoft.SharePoint.PowerShell.SPUserPipeBind

Specifies the login name of the user to be returned.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh or a valid logon in the form DOMAIN\USERNAME.

Web

Required

Microsoft.SharePoint.PowerShell.SPWebPipeBind

Specifies the Web site to be used as a scope.

The type must be a valid GUID, in the form 12345678-90ab-cdef-1234-567890bcdefgh of a valid name of a SharePoint Foundation 2013 Web site (for example, MySPSite1); or an instance of a valid SPWeb object.

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.

NoteNote:
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.

Group

Optional

Microsoft.SharePoint.PowerShell.SPGroupPipeBind

Specifies the user group to which the new user belongs.

Limit

Optional

System.String

Specifies the maximum number of users to return. The default value is 500. To get all of the possible items, enter ‘All’.

------------------EXAMPLE------------------

Get-SPUser -Web "http://zsharepoint2" -Group "Viewers"

This example returns all members of the group Viewers on the Web site http://zsharepoint2.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft