sp-dev-fx-webparts/samples/react-sites-selected-admin/README.md

7.1 KiB

Sites Selected Admin client-side web part

Summary

This is a sample SharePoint Framework client-side web part built using react.

The web part lets you manage your Azure AD applications that have the Sites Selected Api permission. With this web part you'll get an UI for managing what app can connect to which site.

The web part uses the built in MSGraphClient and needs to be approved in API management. The app asks for Microsoft Graph Application.Read.All and Sites.FullControl.All. Users of the web part will need to have Site Collection Administrator privileges to the sites being added to an app.

Web part usage

alt text

Using the web part to grant an app access to a site, start to finish

alt text

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

SPFx 1.11 Node.js v10 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Teams Incompatible Local Workbench Incompatible Hosted Workbench Compatible Compatible with Remote Containers

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

One (or more) Azure AD app with Sites.Selected and the possibility to approve requests in API management (SharePoint Administrator). Site collection administrator is needed for the site(s) you want to give app access to.

Contributors

Version history

Version Date Comments
1.0 February 19, 2021 Initial release
1.1 March 8, 2021 Switch to functional components. Re-factor

Minimal Path to Awesome

  • Add an app in Azure AD, or for an existing app add the Sites.Selected Microsoft Graph api permission

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

alt text

  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • gulp bundle --ship
    • gulp package-solution --ship
  • Add the .sppkg package to your app catalog
  • Approve the api access requests

alt text

  • Install web part on a site of your choice
  • Add permissions to your app
  • Try out the AAD app by sending a request using your favorite method

References

Video

Using a web part to control which Sites have been grated permissions in Azure AD application

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.