Commands › SharePoint Online

Remove-SPOExternalUser

SharePoint Online Microsoft.Online.SharePoint.PowerShell Remove-*

Removes a collection of external users from the tenancy's folder.

Quick start script

# Remove-SPOExternalUser — quick start (serv365.ai)
# 1. Connect (app-only shown; interactive: omit the certificate parameters)
Connect-SPOService -Url https://$org-admin.sharepoint.com

# 2. Capture the current state first — you cannot roll back what you never recorded
$before = Get-SPOExternalUser
$before | Format-List

# 3. Make the change (dry run first)
Remove-SPOExternalUser -UniqueIDs <String[]> -WhatIf
Remove-SPOExternalUser -UniqueIDs <String[]>

# 4. Verify and diff
$after = Get-SPOExternalUser
Compare-Object ($before | Out-String) ($after | Out-String)

Syntax

Remove-SPOExternalUser -UniqueIDs <String[]> [-WhatIf] [-Confirm] [<CommonParameters>]

Parameters (3)

ParameterTypeRequiredWhat it controls
-UniqueIDs String[] yes Specifies an ID that can be used to identify an external user based on their Windows Live ID.
-Confirm SwitchParameter Prompts you for confirmation before running the cmdlet.
-WhatIf SwitchParameter Shows what would happen if the cmdlet runs. The cmdlet is not run.

Reference facts derived from Microsoft documentation, © Microsoft, licensed CC BY 4.0; restructured with original guidance by serv365.ai.