Get-SPOExternalUser
Returns external users in the tenant.
Syntax
Default (Default)
Get-SPOExternalUser
[[-Position] <Int32>]
[[-PageSize] <Int32>]
[[-Filter] <String>]
[[-SortOrder] <SortOrder>]
[[-SiteUrl] <String>]
[-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount <Boolean>]
[<CommonParameters>]
Description
The Get-SPOExternalUser cmdlet returns external users that are located in the tenant based on specified criteria.
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-SPOExternalUser -Position 0 -PageSize 2
Example 1 returns the first two external users in the collection.
EXAMPLE 2
Get-SPOExternalUser -Position 2 -PageSize 2
Example 2 returns two external users from the third page of the collection.
EXAMPLE 3
Get-SPOExternalUser -Position 0 -PageSize 30 -SiteUrl https://contoso.sharepoint.com
Example 3 returns the first 30 users that match the SiteUrl https://contoso.sharepoint.com.
Parameters
-Filter
Applicable: SharePoint Online
Limits the results to only those users whose first name, last name, or email address begins with the text in the string using a case-insensitive comparison.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 4 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-PageSize
Applicable: SharePoint Online
Specifies the maximum number of users to be returned in the collection.
The value must be less than or equal to 50.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 3 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Position
Applicable: SharePoint Online
Use to specify the zero-based index of the position in the sorted collection of the first result to be returned.
Parameter properties
| Type: | System.Int32 |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 2 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount
Applicable: SharePoint Online
Shows users who have accepted an invite but not using the account the invite was sent to.
Parameter properties
| Type: | System.Boolean |
| 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 |
-SiteUrl
Applicable: SharePoint Online
Specifies the site to retrieve external users for.
If no site is specified, the external users for all sites are returned.
Parameter properties
| Type: | System.String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 6 |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-SortOrder
Applicable: SharePoint Online
Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur.
Parameter properties
| Type: | Microsoft.Online.SharePoint.TenantManagement.SortOrder |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 5 |
| Mandatory: | False |
| 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.