How to Delete Users From the Group in SharePoint Using REST API

This example shows how to delete users from the group in SharePoint using the REST API. Develop the project using the following method in the NAPA Tool.

On your Developer Site, open the "Napa" Office 365 Development Tools and then choose Add New Project.

  • Choose the App for SharePoint template, name the project Create Site and then choose the Create button.
  • Replace APP.js with the following source code below.
  • Publish Your App.

Prerequisites

These are important steps to be done before creating the app.

Specify the permissions that your app needs as in the following.

Choose the Properties button at the bottom of the page.

  • In the Properties window, choose Permissions.
  • In the Content category, set the Write permissions for the Tenant scope.
  • In the Social category, set the Read permissions for the User Profiles scope.
  • Close the Properties window.

Endpoint Syntax

  1. url: "<app web Url>/_api/SP.AppContextSite(@target)/web/sitegroups(7)/users  
  2.     /getbyemail('user@domain.com'),  
  3.     ?@target='<host web url>'",  
  4.   method: "POST",  
  5.   headers: { "X-HTTP-Method""DELETE" },  

Source Code

  1. 'use strict';  
  2. var hostweburl;  
  3. var appweburl;  
  4. // Get the URLs for the app web the host web URL from the query string.  
  5. $(document).ready(function()  
  6. {  
  7.     //Get the URI decoded URLs.  
  8.     hostweburl = decodeURIComponent(getQueryStringParameter("SPHostUrl"));  
  9.     appweburl = decodeURIComponent(getQueryStringParameter("SPAppWebUrl"));  
  10.     // Resources are in URLs in the form:  
  11.     // web_url/_layouts/15/resource  
  12.     // Load the js file and continue to load the page with information about the folders.  
  13.     // SP.RequestExecutor.js to make cross-domain requests  
  14.     $.getScript(hostweburl + "/_layouts/15/SP.RequestExecutor.js", getuser);  
  15. });  
  16. function getuser()   
  17. {  
  18.     var executor;  
  19.     var userEmail = "gowthamdev@Gauti.onmicrosoft.com";  
  20.     // Initialize the RequestExecutor with the app web URL.  
  21.     executor = new SP.RequestExecutor(appweburl);  
  22.     executor.executeAsync({  
  23.         url: appweburl + "/_api/SP.AppContextSite(@target)/web/sitegroups(6)/users/getbyemail('" + userEmail + "')?@target='" + hostweburl + "'",  
  24.         method: "POST",  
  25.         headers: {  
  26.             "X-HTTP-Method""DELETE"  
  27.         },  
  28.         success: function(data) {  
  29.             alert("User Deleted successfully in SharePoint Group");  
  30.         },  
  31.         error: function(err) {  
  32.             alert("error: " + JSON.stringify(err));  
  33.         }  
  34.     });  
  35. }  
  36. //Utilities  
  37. // Retrieve a query string value.  
  38. // For production purposes you may want to use a library to handle the query string.  
  39. function getQueryStringParameter(paramToRetrieve) {  
  40.     var params = document.URL.split("?")[1].split("&");  
  41.     for (var i = 0; i < params.length; i = i + 1) {  
  42.         var singleParam = params[i].split("=");  
  43.         if (singleParam[0] == paramToRetrieve) return singleParam[1];  
  44.     }  
  45. }  
Publish

Publish the app and click the Trust it Button.



Output

User Deleted from the Group Successfully.