Export (0) Print
Expand All

Get-SPOExternalUser

 

Applies to: SharePoint Online

Topic Last Modified: 2014-04-21

Returns external users in the tenant’s folder.

Get-SPOExternalUser [-Filter <String>] [-PageSize <Int32>] [-Position <Int32>] [-SiteUrl <String>] [-SortOrder <Ascending | Descending>]

-----------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 -Filter @testsite.com

Example 3 returns the first 30 users that match the filter, @testsite.com.

The Get-SPOExternalUser cmdlet returns external users that are located in the tenant's folder based on specified criteria.

 

Parameter Required Type Description

Filter

Optional

System.String

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

PageSize

Optional

System.Int32

Specifies the maximum number of users to be returned in the collection.

The value must be less than or equal to 50.

Position

Optional

System.Int32

Use to specify the zero-based index of the position in the sorted collection of the first result to be returned.

SiteUrl

Optional

System.String

Specifies the site to retrieve external users for. If no site is specified, the external users for all sites are returned.

SortOrder

Optional

Microsoft.Online.SharePoint.TenantManagement.SortOrder

Specifies the sort results in Ascending or Descending order on the SPOUser.Email property should occur.

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