Remove-MSTTeamUser

Teams: Remove owners or members from a team

Script

#Requires -Version 5.1

[CmdletBinding()]
Param(
    [Parameter(Mandatory = $true, ParameterSetName = 'Single')]
    [Parameter(Mandatory = $true, ParameterSetName = 'Multi')]
    [string]$GroupId,
    [Parameter(Mandatory = $true, ParameterSetName = 'Multi')]
    [string[]]$Users,
    [Parameter(Mandatory = $true, ParameterSetName = 'Single')]
    [string]$User,
    [Parameter(ParameterSetName = 'Single')]
    [switch]$UserIsOwner
)

Process {
    try {
        $team = Get-Team -GroupId $GroupId -ErrorAction Stop | Select-Object -ExpandProperty DisplayName
        [hashtable]$cmdArgs = @{'ErrorAction' = 'Stop'; 'GroupId' = $GroupId}

        if ($PSCmdlet.ParameterSetName -eq 'Single') {
            $Users = @($User)
        }
        else {
            if ($UserIsOwner) {
                $cmdArgs.Add('Role', 'Owner')
            }
        }

        $result = @()
        foreach ($usr in $Users) {
            try {
                $null = Remove-TeamUser @cmdArgs -User $usr
                $result += "User $($usr) removed from team $($team)"
            }
            catch {
                $result += "Error removing user $($usr) from team $($team)"
            }
        }

        foreach ($msg in $result) {
            [PSCustomObject]@{
                Timestamp = Get-Date -Format 'yyyy-MM-dd HH:mm:ss'
                Result    = $msg
            }
        }
    }
    catch { throw }
}

Customize

GroupId string

GroupId of the team

Users string

One or more User UPNs for bulk removal

User string

User's UPN for single user removal

UserIsOwner switch

Off

Indicates the user is in the owner role