Remove-PnPEntraIDUser
SYNOPSIS
Required Permissions
- Microsoft Graph API: User.ReadWrite.All
Removes a user from Entra ID.
SYNTAX
Remove-PnPEntraIDUser -Identity <EntraIDUserPipeBind> [-WhatIf] [-Connection <PnPConnection>] [-Verbose]
DESCRIPTION
Allows a user to be removed from Entra ID. When the user is deleted, the user will be moved to the recycle bin and can be restored within 30 days. After 30 days the user will be permanently deleted.
EXAMPLES
EXAMPLE 1
Remove-PnPEntraIDUser -Identity johndoe@contoso.onmicrosoft.com
The user with the provided UPN will be removed from Entra ID.
EXAMPLE 2
Remove-PnPEntraIDUser -Identity 5a4c547a-1440-4f64-9952-a0c6f1c9e7ea
The user with the provided guid will be removed from Entra ID.
EXAMPLE 3
Get-PnPEntraIDUser | Where-Object { $_.OfficeLocation -eq "London" } | Remove-PnPEntraIDUser
Removes all users that have their OfficeLocation set to London from Entra ID.
EXAMPLE 4
Get-PnPEntraIDUser -Filter "accountEnabled eq false" | Remove-PnPEntraIDUser
Removes all disabled user accounts from Entra ID.
PARAMETERS
-Connection
Optional connection to be used by the cmdlet. Retrieve the value for this parameter by either specifying -ReturnConnection on Connect-PnPOnline or by executing Get-PnPConnection.
Type: PnPConnection
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Identity
The identity of the user to remove. This can be the UPN, the GUID or an instance of the user.
Type: EntraIDUserPipeBind
Parameter Sets: (All)
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Verbose
When provided, additional debug statements will be shown while executing the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-WhatIf
When used in combination with -Verbose, it will show what would happen if the cmdlet runs. The user will not be deleted.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False