Group Operations In SharePoint 2016 And Office 365 Using JavaScript Object Model

SharePoint groups were designed with the aim to manage SharePoint permissions. In a nutshell, SharePoint group is a collection of the users who share the same permission level. Assigning permission directly to the users is not considered a good practice. The users should be added to a SharePoint group, which in turn should be assigned the permissions in the SharePoint object hierarchy. In addition to it, grouping the users into the groups helps to organize and manage security; which is an important aspect of SharePoint.

SharePoint groups can be created and modified from the site permission page.



Let’s see how we can create and delete SharePoint groups, using JavaScript object model.

Create Group

• Add reference to jquery file, as shown below:
  
  1. <script language="javascript" type="text/javascript" src="//ajax.googleapis.com/ajax/libs/jquery/1.8.1/jquery.min.js">
  2. </script>
  3. <script language="javascript" type="text/javascript">
• Within document, call SP.SOD.executeFunc; so as to load the on demand script SP.js . Call the main starting point function say, createGroup.
  
  1. SP.SOD.executeFunc('sp.js', 'SP.ClientContext', createGroup);
• Instantiate the client context and get the Web instance. Once the Web object is retrieved, get the group collection object.
  
  1. var clientContext = new SP.ClientContext();
  2. var oWeb = clientContext.get_web();
  4. //Get group collection
  5. var groupCollection = oWeb.get_siteGroups();
• Add the new group to the collection, as shown below:
  
  1. var newGroup = new SP.GroupCreationInformation();
  2. newGroup.set_title('Administrator Group');
  3. newGroup.set_description('This group handles the access to Admin documents');
  4. oWeb.get_siteGroups().add(newGroup);
• Load the client context and execute the batch which will send the request to the Server and perform the entire JavaScript object model operations as a batch.
  
  1. clientContext.load(groupCollection);
  2. clientContext.executeQueryAsync(QuerySuccess, QueryFailure);

Output


Full Code

• Follow the syntax of the full code given above, get the group collection and from that use getByName method to select the group to delete.
  
  1. oGroupCollection = oWeb.get_siteGroups();
  2. oGroup = oGroupCollection.getByName("Administrator Group");
• Load the client context and execute the batch.
  
  1. clientContext.load(oGroupCollection);
  2. clientContext.load(oGroup);
  3. clientContext.executeQueryAsync(QuerySuccess, QueryFailure);
• In the success-call back method delete the group from the group collection.
  
  1. oGroupCollection.removeByLoginName(oGroup.get_loginName());