Remove-MsOUser.ps1

#Requires -Version 5.0
#Requires -Modules MSOnline

<#
    .SYNOPSIS
        Connect to MS Online and remove a user from Azure Active Directory
    
    .DESCRIPTION  

    .NOTES
        This PowerShell script was developed and optimized for ScriptRunner. The use of the scripts requires ScriptRunner. 
        The customer or user is authorized to copy the script from the repository and use them in ScriptRunner. 
        The terms of use for ScriptRunner do not apply to this script. In particular, ScriptRunner Software GmbH assumes no liability for the function, 
        the use and the consequences of the use of this freely available script.
        PowerShell is a product of Microsoft Corporation. ScriptRunner is a product of ScriptRunner Software GmbH.
        © ScriptRunner Software GmbH

    .COMPONENT       
        Azure Active Directory Powershell Module

    .LINK
        https://github.com/scriptrunner/ActionPacks/tree/master/O365/MSOnline/Users

    .Parameter UserObjectId
        [sr-en] Unique object ID of the user to remove

    .Parameter UserName
        [sr-en] Display name, Sign-In Name or user principal name of the user to remove

    .Parameter RemoveFromRecycleBin
        [sr-en] Removes user from the Azure Active Directory recycle bin

    .Parameter TenantId
        [sr-en] Unique ID of the tenant on which to perform the operation
#>

param(
    [Parameter(Mandatory = $true,ParameterSetName = "User object id")]
    [guid]$UserObjectId,
    [Parameter(Mandatory = $true,ParameterSetName = "User name")]
    [string]$UserName,    
    [Parameter(ParameterSetName = "User name")]
    [Parameter(ParameterSetName = "User object id")]
    [switch]$RemoveFromRecycleBin,
    [Parameter(ParameterSetName = "User name")]
    [Parameter(ParameterSetName = "User object id")]
    [guid]$TenantId
)

try{
    $Script:User 

    if([System.String]::IsNullOrWhiteSpace($UserName)){
        $Script:User = Get-MsolUser -ObjectId $UserObjectId -TenantId $TenantId  | Select-Object *
    }
    else{
        $Script:User = Get-MsolUser -TenantId $TenantId | `
                            Where-Object {($_.DisplayName -eq $UserName) -or ($_.SignInName -eq $UserName) -or ($_.UserPrincipalName -eq $UserName)} | `
                            Select-Object *
    }
    if($null -ne $Script:User){
        $null = Remove-MsolUser -ObjectId $Script:User.ObjectID -Force -TenantId $TenantId
        if($RemoveFromRecycleBin -eq $true){
            $null = Remove-MsolUser -ObjectId $Script:User.ObjectID -Force -RemoveFromRecycleBin -TenantId $TenantId
        }
        if($SRXEnv) {
            $SRXEnv.ResultMessage ="User $($Script:User.DisplayName) removed"
        }
        else {
            Write-Output "User $($Script:User.DisplayName) removed"
        }
    }
    else{
        if($SRXEnv) {
            $SRXEnv.ResultMessage = "User not found"
        }    
        Throw "User not found"
    }
}
catch{
    throw
}