Get-SPOUser
Returns the SharePoint Online user or security group accounts that match a given search criteria.
Syntax
All (Default)
Get-SPOUser
-Site <SpoSitePipeBind>
[-Limit <String>]
[<CommonParameters>]
ByGroup
Get-SPOUser
-Site <SpoSitePipeBind>
[-Group <String>]
[-Limit <String>]
[<CommonParameters>]
ByLogin
Get-SPOUser
-Site <SpoSitePipeBind>
[-LoginName <String>]
[<CommonParameters>]
Description
This cmdlet contains more than one parameter set. You may only use parameters from one parameter set and you may not combine parameters from different parameter sets. For more information about how to use parameter sets, see Cmdlet Parameter Sets.
The Get-SPOUser cmdlet matches one and only one user or security group.
Be sure to run the Get-SPOUser cmdlet as at least a SharePoint Online administrator and be a site collection administrator of the queried site.
For permissions and the most current information about Windows PowerShell for SharePoint Online, see the online documentation at https://go.microsoft.com/fwlink/p/?LinkId=251832.
Examples
EXAMPLE 1
Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance
Example 1 returns all user or security group accounts from the site collection https://contoso.sharepoint.com/sites/finance.
EXAMPLE 2
Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -LoginName melissa.kerr@contoso.com
Example 2 returns one user or security group account whose user name is "melissa.kerr@contoso.com" from the site collection https://contoso.sharepoint.com/sites/finance.
EXAMPLE 3
Get-SPOUser -Site https://contoso.sharepoint.com/sites/finance -Group "Team Site Members"
Example 3 returns one user or security group account inside group Team Site Members from the site collection https://contoso.sharepoint.com/sites/finance.
Parameters
-Group
Applicable: SharePoint Online
Specifies the group to get the users from.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Limit
Applicable: SharePoint Online
Specifies the maximum number of users returned. The default value is to return 500 users. To return all users specify the value "All".
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
All
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
ByGroup
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LoginName
Applicable: SharePoint Online
Specifies the user name.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
ByLogin
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Site
Applicable: SharePoint Online
Specifies the URL of the site collection to get the user from.
Parameter properties
| Type: | Microsoft.Online.SharePoint.PowerShell.SpoSitePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | True |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.