Feature: Add support for removing multiple users from a Teams team (#…

…4650) Co-authored-by: Gautam Sheth <[email protected]>
pnp · Dec 24, 2024 · 2e86810 · 2e86810
1 parent a891180
commit 2e86810
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 9 deletions.
diff --git a/documentation/Remove-PnPTeamsUser.md b/documentation/Remove-PnPTeamsUser.md
@@ -13,7 +13,7 @@ online version: https://pnp.github.io/powershell/cmdlets/Remove-PnPTeamsUser.htm
 
 **Required Permissions**
 
-  * Microsoft Graph API: Group.ReadWrite.All
+  * Microsoft Graph API: Group.ReadWrite.All, TeamMember.ReadWrite.All
 
 Removes a user from a team.
 
@@ -44,6 +44,13 @@ Remove-PnPTeamsUser -Team MyTeam -User [email protected] -Role Owner
 
 Removes the user [email protected] from the owners of the team, but retains the user as a member.
 
+### EXAMPLE 3
+```powershell
+Remove-PnPTeamsUser -Team MyTeam -Users "[email protected]","[email protected]","[email protected]"
+```
+
+Removes the users [email protected], [email protected] and [email protected] from the team.
+
 ## PARAMETERS
 
 ### -Force
@@ -67,7 +74,7 @@ Specify the role of the user you are removing from the team. Accepts "Owner" and
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: (User)
 
 Required: False
 Position: Named
@@ -95,7 +102,21 @@ Specify the UPN (e.g. [email protected])
 
 ```yaml
 Type: String
-Parameter Sets: (All)
+Parameter Sets: (User)
+
+Required: True
+Position: Named
+Default value: None
+Accept pipeline input: False
+Accept wildcard characters: False
+```
+
+### -Users
+Specify the list of UPN (e.g. [email protected])
+
+```yaml
+Type: String
+Parameter Sets: (Users)
 
 Required: True
 Position: Named

diff --git a/src/Commands/Teams/RemoveTeamsUser.cs b/src/Commands/Teams/RemoveTeamsUser.cs
@@ -8,19 +8,29 @@
 namespace PnP.PowerShell.Commands.Teams
 {
     [Cmdlet(VerbsCommon.Remove, "PnPTeamsUser")]
+    [RequiredApiDelegatedOrApplicationPermissions("graph/Group.Read.All")]
     [RequiredApiDelegatedOrApplicationPermissions("graph/Group.ReadWrite.All")]
+    [RequiredApiDelegatedOrApplicationPermissions("graph/TeamMember.ReadWrite.All")]
     public class RemoveTeamsUser : PnPGraphCmdlet
     {
-        [Parameter(Mandatory = true)]
+        const string ParamSet_ByUser = "By User";
+        const string ParamSet_ByMultipleUsers = "By Multiple Users";
+
+        [Parameter(Mandatory = true, ParameterSetName = ParamSet_ByUser)]
+        [Parameter(Mandatory = true, ParameterSetName = ParamSet_ByMultipleUsers)]
         public TeamsTeamPipeBind Team;
 
-        [Parameter(Mandatory = true)]
+        [Parameter(Mandatory = true, ParameterSetName = ParamSet_ByUser)]
         public string User;
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = true, ParameterSetName = ParamSet_ByMultipleUsers)]
+        public string[] Users;
+
+        [Parameter(Mandatory = false, ParameterSetName = ParamSet_ByUser)]
         public string Role = "Member";
 
-        [Parameter(Mandatory = false)]
+        [Parameter(Mandatory = false, ParameterSetName = ParamSet_ByUser)]
+        [Parameter(Mandatory = false, ParameterSetName = ParamSet_ByMultipleUsers)]
         public SwitchParameter Force;
 
         protected override void ExecuteCmdlet()
@@ -30,9 +40,19 @@ protected override void ExecuteCmdlet()
             {
                 try
                 {
-                    if (Force || ShouldContinue($"Remove user with UPN {User}?", Properties.Resources.Confirm))
+                    if (ParameterSetName == ParamSet_ByUser)
+                    {
+                        if (Force || ShouldContinue($"Remove user with UPN {User}?", Properties.Resources.Confirm))
+                        {
+                            TeamsUtility.DeleteUser(RequestHelper, groupId, User, Role);
+                        }
+                    }
+                    else
                     {
-                        TeamsUtility.DeleteUser(RequestHelper, groupId, User, Role);
+                        if (Force || ShouldContinue($"Remove specifed users from the team ?", Properties.Resources.Confirm))
+                        {
+                            TeamsUtility.DeleteUsers(RequestHelper, groupId, Users, Role);
+                        }
                     }
                 }
                 catch (GraphException ex)

diff --git a/src/Commands/Utilities/TeamsUtility.cs b/src/Commands/Utilities/TeamsUtility.cs
@@ -627,6 +627,26 @@ public static TeamUser UpdateTeamUserRole(ApiRequestHelper requestHelper, string
             return result;
         }
 
+        public static void DeleteUsers(ApiRequestHelper requestHelper, string groupId, string[] upn, string role)
+        {
+            var teamChannelMember = new List<TeamChannelMember>();
+            if (upn != null && upn.Length > 0)
+            {
+                foreach (var user in upn)
+                {
+                    teamChannelMember.Add(new TeamChannelMember() { Roles = null, UserIdentifier = $"https://{requestHelper.GraphEndPoint}/v1.0/users('{user}')" });
+                }
+                if (teamChannelMember.Count > 0)
+                {
+                    var chunks = BatchUtility.Chunk(teamChannelMember, 200);
+                    foreach (var chunk in chunks.ToList())
+                    {
+                        requestHelper.Post($"v1.0/teams/{groupId}/members/remove", new { values = chunk.ToList() });
+                    }
+                }
+            }
+        }
+
         #endregion
 
         #region Channel