Consume the Microsoft Graph API using PnP in SPFx

This article provides steps to consume the Microsoft Graph API using PnP Graph package in the SharePoint Framework (SPFx) web part, we can access Graph API in many ways across the all the logic this is the easiest. we going to get people information using Graph API, this is the same logic can use to access any of the Office 365 data using PnP Graph. 

Create a new web part project

Open power shell and run following comment to create a new web part by running the Yeoman SharePoint Generator

yo @microsoft/sharepoint

When prompted:

Enter the webpart name as your solution name, and then select Enter.
Select Create a subfolder with solution name for where to place the files.
Select Y to allow the solution to be deployed to all sites immediately.
Select N on the question if solution contains unique permissions.
Select WebPart as the client-side component type to be created.

The next set of prompts ask for specific information about your web part:

Enter your web part name, and then select Enter.
Enter your web part description, and then select Enter.
Select React framework as the framework you would like to use, and then select Enter.

Start Visual Studio Code (or your favourite code editor) within the context of the newly created project folder.

cd .\web part name\
code .

Install the library and required dependencies

npm install @pnp/graph --save

Configure the custom properties

Create a new source code file under the src\webparts\<web part name>\components\ folder of the solution. Call the new file I<web part name>State.ts and use it to create a TypeScript Interface

export interface ISpfxPnpGraphState {
  description: string;
  users:IUserItem[];
}

export interface IUserItem {
  displayName: string;
  url: string;
  userPrincipalName: string;
  profileImageSrc:string;
  jobTitle:string;
}

Update the <web part name>.tsx file. First, add some import statements to import the types you defined earlier. Notice the import for I<web part name>Props and I<web part name>State. There are also some imports for the PnP components used to render the UI of the PnP React component and pnp sp imports.

import * as React from 'react';
import styles from './SpfxPnpGraph.module.scss';
import { ISpfxPnpGraphProps } from './ISpfxPnpGraphProps';
import { ISpfxPnpGraphState, IUserItem } from './ISpfxPnpGraphState';
import {
  DocumentCardActivity
} from 'office-ui-fabric-react/lib/DocumentCard';
import { graph } from "@pnp/graph";
import "@pnp/graph/users"
import "@pnp/graph/contacts"

Replace this render function with the following code.

  private async _getPeople() {
    var users: Array<IUserItem> = new Array<IUserItem>();
    const peoplecol = await graph.me.people.top(15)();
    peoplecol.map((people: any) => {
      users.push({
        displayName: people.displayName,
        url: this.props.context.pageContext.web.absoluteUrl + '/PersonImmersive.aspx?accountname=i%3A0%23%2Ef%7Cmembership%7C' + people.userPrincipalName,
        userPrincipalName: people.userPrincipalName,
        profileImageSrc: this.props.context.pageContext.web.absoluteUrl + "/_layouts/15/userphoto.aspx?size=L&username=" + people.userPrincipalName,
        jobTitle: people.jobTitle
      });
    });
    this.setState({ users: users })
  }

Update the React component type declaration and add a constructor, as shown in the following example.

export default class SpfxPnpGraph extends React.Component<ISpfxPnpGraphProps, ISpfxPnpGraphState> {
  constructor(props: ISpfxPnpGraphProps, state: ISpfxPnpGraphState) {
    super(props);
    graph.setup({
      spfxContext: this.props.context
    });
    this.state = { description: '', users: [] }
    this._getPeople()
  }

Add below event function inside the react component for upload files to SharePoint Library

  private async _getPeople() {
    var users: Array<IUserItem> = new Array<IUserItem>();
    const peoplecol = await graph.me.people.top(15)();
    peoplecol.map((people: any) => {
      users.push({
        displayName: people.displayName,
        url: this.props.context.pageContext.web.absoluteUrl + '/PersonImmersive.aspx?accountname=i%3A0%23%2Ef%7Cmembership%7C' + people.userPrincipalName,
        userPrincipalName: people.userPrincipalName,
        profileImageSrc: this.props.context.pageContext.web.absoluteUrl + "/_layouts/15/userphoto.aspx?size=L&username=" + people.userPrincipalName,
        jobTitle: people.jobTitle
      });
    });
    this.setState({ users: users })
  }

Configuring Permission request

Have to configure the Graph API access request, it totally based on the what data you want to access using Graph API. In the package-soltion.ts file which located under config folder. In this file you have to add webApiPermissionRequests property in the JSON.

{
  "$schema": "https://developer.microsoft.com/json-schemas/spfx-build/package-solution.schema.json",
  "solution": {
    "name": "spfx-pnp-graph-client-side-solution",
    "id": "ca39bbbc-8c41-4bef-9043-395bbb53e62e",
    "version": "1.0.0.0",
    "includeClientSideAssets": true,
    "skipFeatureDeployment": true,
    "isDomainIsolated": false,
    "webApiPermissionRequests": [
      {
        "resource": "Microsoft Graph",
        "scope": "People.Read.All"
      }
    ]
  },
  "paths": {
    "zippedPackage": "solution/spfx-pnp-graph.sppkg"
  }
}

If you not sure not exactly what permission you have to configure then the visit the Microsoft graph explorer. In this page you can find the tab called Modify permission, in that tab, you can find what exact permission you have to configure for your API call

Deploy the solution

You’re now ready to build, bundle, package, and deploy the solution.

Run the gulp commands to verify that the solution builds correctly.

gulp build

Use the following command to bundle and package the solution.

gulp bundle --ship
gulp package-solution --ship

Browse to the app catalog of your target tenant and upload the solution package. You can find the solution package under the sharepoint/solution folder of your solution. It is the .sppkg file.

After you upload the solution package in the app catalog. you can find and the web part anywhere across the tenant. before you add the package in the page, you have to make sure permission requests are approved under 

https://<tenant>-admin.sharepoint.com/_layouts/15/online/AdminHome.aspx#/webApiPermissionManagement

Sharing is caring!

If you have any questions, feel free to let me know in the comments section.
Happy coding!!!

Comments

Fill in your details below or click an icon to log in:

WordPress.com Logo

You are commenting using your WordPress.com account. Log Out /  Change )

Google photo

You are commenting using your Google account. Log Out /  Change )

Twitter picture

You are commenting using your Twitter account. Log Out /  Change )

Facebook photo

You are commenting using your Facebook account. Log Out /  Change )

Connecting to %s