Get-SPOExternalUser
Returns external users in the tenant.
Syntax
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 2Example 1 returns the first two external users in the collection.
-----------------------EXAMPLE 2-----------------------------
Get-SPOExternalUser -Position 2 -PageSize 2Example 2 returns two external users from the third page of the collection.
-----------------------EXAMPLE 3-----------------------------
Get-SPOExternalUser -Position 0 -PageSize 30 -SiteUrl https://contoso.sharepoint.comExample 3 returns the first 30 users that match the SiteUrl https://contoso.sharepoint.com.
Parameters
-Filter
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.
| Type: | String |
| Position: | 4 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-PageSize
Specifies the maximum number of users to be returned in the collection.
The value must be less than or equal to 50.
| Type: | Int32 |
| Position: | 3 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-Position
Use to specify the zero-based index of the position in the sorted collection of the first result to be returned.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount
Shows users who have accepted an invite but not using the account the invite was sent to.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SiteUrl
Specifies the site to retrieve external users for.
If no site is specified, the external users for all sites are returned.
| Type: | String |
| Position: | 6 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |
-SortOrder
Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur.
| Type: | SortOrder |
| Position: | 5 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | SharePoint Online |