Get-ExternalUser

SharePoint Online: Gets external users

Script

#Requires -Version 5.1
#Requires -Modules Microsoft.Online.SharePoint.PowerShell

[CmdletBinding()]
Param(
    [string]$Filter,
    [ValidateRange(1, 50)]
    [int]$PageSize,
    [int]$Position,
    [bool]$ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount,
    [string]$SiteUrl,
    [ValidateSet('Ascending','Descending')]
    [string]$SortOrder
)

Process {
    try {
        $cmdArgs = @{ ErrorAction = 'Stop'; ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount = $ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount }
        if ($PSBoundParameters.ContainsKey('Filter')) { $cmdArgs.Add('Filter', $Filter) }
        if ($PSBoundParameters.ContainsKey('PageSize')) { $cmdArgs.Add('PageSize', $PageSize) }
        if ($PSBoundParameters.ContainsKey('Position')) { $cmdArgs.Add('Position', $Position) }
        if ($PSBoundParameters.ContainsKey('SiteUrl')) { $cmdArgs.Add('SiteUrl', $SiteUrl) }
        if ($PSBoundParameters.ContainsKey('SortOrder')) { $cmdArgs.Add('SortOrder', $SortOrder) }
        $result = Get-SPOExternalUser @cmdArgs | Select-Object *
        if ($null -ne $result) { foreach ($item in $result) { $item | Add-Member -NotePropertyName Timestamp -NotePropertyValue (Get-Date -Format "yyyy-MM-dd HH:mm:ss") -PassThru -Force } }
    }
    catch { throw }
}

Customize

Filter string

Limits results to users whose name or email begins with the specified text

PageSize int

Maximum number of users to return (1-50)

Position int

Zero-based index of the first result to return

ShowOnlyUsersWithAcceptingAccountNotMatchInvitedAccount bool

Shows users who accepted with a different account than invited

SiteUrl string

Site to retrieve external users for

SortOrder string

Sort order: Ascending or Descending