sp-dev-fx-webparts/samples/react-check-user-group/README.md

4.5 KiB

Check User Group

Summary

This web part finds all the Office 365 or AAD Security groups a user is a member of or all the members present in such a group. It can be used as an admin utility to quickly check the membership of any user or group from within a SharePoint page itself. The retrieved results can also be exported to a CSV file.

Check User Group

Compatibility

SPFx 1.10 Node.js v10 | v8 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Incompatible Hosted Workbench Compatible

Features

This web part uses Microsoft Graph API to get all the Office 365 or AAD Security Groups a user is a member of or all the members in such a group.

This extension illustrates the following concepts:

  • Requesting Directory.Read.All permission scope for Microsoft Graph through the webApiPermissionRequests property in package-solution.json
  • Using MSGraphClient to call the /groups/{groupId}/members API to get all the members in a group
  • Using MSGraphClient to call the /users/${email}/memberOf API to get all the groups a user is member of
  • Exporting the results to a CSV file using react-csv third party package

Solution

Solution Author(s)
react-check-user-group Aakash Bhardwaj

Minimal Path to Awesome

  • Clone this repository
  • npm install
  • gulp bundle --ship
  • gulp package-solution --ship
  • Add to Site Collection App Catalog and Install the App
  • Go to the API Management section in the new SharePoint Admin Center (https://{tenantname}-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement)
  • Approve the permission request for Directory.Read.All to Microsoft Graph

Help

We do not support samples, but we this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues while using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.