Installing the Microsoft Graph App On Microsoft Azure Active Directory

To achieve this, follow the steps detailed below:

  1. Login to the Office 365 portal as a Global Administrator and click on the Admin option within (see Figure 196).

    Figure 196 : Clicking on Admin option in Office 365 portal

  2. When Figure 197 appears, browse the left panel of Figure 197 for the Admin Centers node. Expand the node and select the Azure Active Directory sub-node within.

    Figure 197 : Clicking on Azure Active Directory under Admin Centers

  3. Figure 198 then appears. Select Azure Active Directory from the list of FAVORITES in the left-most panel of Figure 198. Then, from the App Registrations list for Azure Active Directory, select App registrations to register the Microsoft Graph app.

    Figure 198 : Selecting the App registrations option to register a new app on Azure AD

  4. Figure 199 then appears, using which you can register the Microsoft Graph app. In the Name text box, specify the display name of the app you intend to register. Make sure you copy this name to notepad. Then, from the drop-down in the Redirect URI section, select Web. In the text box adjacent to the drop-down, specify the URL to which the authentication response needs to be returned after successfully authenticating users to the new app. Make sure that this URI ends with 'my-sharepoint' - eg., https://myapp.com/my-sharepoint. Finally, click the Register button in Figure 199 to register Microsoft Graph on Azure AD.

    Figure 199 : Registering the Microsoft Graph app on Azure AD

  5. Upon successful app registration, Figure 200 will appear displaying a message to that effect. Additionally, Figure 200 will display the Application (client) ID that is auto-generated and auto-assigned to the Microsoft Graph app. Make sure you copy this ID also to notepad.

    Figure 200 : Viewing and making a note of the Application ID of the Microsoft Graph app

  6. Next, proceed to create a secret for the new app. To achieve this, click on the Certificates & Secrets option under Manage in the left panel of Figure 200. Figure 201 will then appear. Now, click on the New client secret button in the Client Secrets section in the right panel of Figure 201.

    Figure 201 : Clicking on the New client secret button

  7. When Figure 202 appears, provide a Description for the new secret, set it to Never expire, and click the Add button to add the new secret.

    Figure 202 : Creating a new secret for the Microsoft Graph App

  8. Once the new secret is successfully created, a key will be generated for it, as depicted by Figure 203. Make a note of this key in notepad.

    Figure 203 : The key that is generated and assigned to the client secret of the Microsoft Graph app

  9. Next, proceed to grant permissions to the Microsoft Graph app, so it can pull the desired metrics. For this, click on the API permissions option under Manage in the left panel of Figure 203. This will invoke Figure 204. In the right panel of Figure 204, click on the Add a permission button.

    Figure 204 : Clicking on the Add a permission button

  10. Then, click on Office 365 Management APIs in the Request API Permissions window that appears (see Figure 205).

    Figure 205 : Selecting the Office 365 Management APIs option

  11. When Figure 206 appears, click on Application permissions. Then, when the Permission tree appears below, expand the ServiceHealth node and select the ServiceHealth.Read option to assign that permission to the Microsoft Graph app. This will allow the Microsoft Graph app to read the service health information for your organization. Finally, click on Add permissions to add the chosen permission.

    Figure 206 : Granting permission to the Microsoft Graph app to read service health

  12. When Figure 207 appears, click on the Add a permission button again.

    Figure 207 : Clicking on the Add a permission button again to add permission to read from and write to user files

  13. From Figure 208 that then appears, select the SharePoint option.

    Figure 208 : Selecting the SharePoint option

  14. Then, select the Delegated permissions option from Figure 209, expand the MyFiles node in the Permission tree, and check the MyFiles.Read and MyFiles.Write check boxes within. Doing so will allow the Microsoft Graph app to read from and write to user files. As before, click the Add permissions button to add the chosen permissions to the Microsoft Graph app.

    Figure 209 : Granting permission to Microsoft Graph app to read from and write to user files

  15. You will now return to Figure 207. Once again, click on the Add a permission button therein to grant another permission to Microsoft Graph. When Figure 208 appears, select the SharePoint option yet again. Next, as depicted by Figure 210, select Application permissions, expand the Sites node in the Permission tree, and select the Sites.Read.All check box. Doing so will allow the Microsoft Graph app to read items in all site collections. Click on Add permissions in Figure 210 to add the chosen permission to Microsoft Graph app.

    Figure 210 : Granting permission to Microsoft Graph app to read items in all site collections

  16. You will once again return to Figure 207. Click on the Add a permission button therein. When Figure 211 appears, select the Azure Active Directory Graph option.

    Figure 211 : Selecting the Azure Active Directory Graph option

  17. From Figure 212, select Delegated Permissions. Then, expand the User node in the Permission tree, and select the User.Read check box. This will allow the Microsoft Graph app to sign in and read the user profile. As before, click the Add permissions button to grant the chosen permission to the Microsoft Graph app.

    Figure 212 : Granting the Microsoft Graph app permission to sign in and read user profile

  18. As soon as you return to Figure 207, click the Add a permission button yet again. This time, click on the APIs my organization uses tab page in the Request API permissions window of Figure 208. Scroll down the list of APIs that appears until the Microsoft Graph API comes into view. Choose this API.

    Figure 213 : Choosing the Microsoft Graph API

  19. Next, expand the Group node in the Permission tree, and select the Group.Read.All check box within. This will allow the Microsoft Graph app to read all groups.

    Figure 214 : Granting the Microsoft Graph app permission to read all groups

  20. Next, expand the User node in the Permission tree, and select the User.Read.All check box within. This will enable the Microsoft Graph app to read the full profile of all users.

    Figure 215 : Granting the Microsoft Graph app permission to read full profile of all users

  21. Next, expand the Reports node in the Permission tree, and select the Reports.Read.All check box within. This will permit the Microsoft Graph app to read all usage reports.

    Figure 216 : Granting permission to the Microsoft Graph app to read all usage reports

  22. Finally, click the Add permissions button in Figure 216 to add all the chosen permissions to the Microsoft Graph app. When Figure 217 appears, click the Grant admin consent for <user> button therein to grant admin consent for the user.

    Figure 217 : Granting admin consent to the user

  23. Next, proceed to create a .dat file to which the details of the Microsoft Graph app - i.e., the app name, its client ID, and client secret - will be written. At run time, the eG agent reads the .dat file to know which app should be used for pulling metrics from Office 365. To create the .dat file, first, login to the eG agent host, Then, using Powershell ISE, execute the CreateGraphDat.ps1 command from the <EG_INSTALL_DIR>\lib\O365 directory. Upon successful command execution, the dialog box depicted by Figure 218 will appear.

    Figure 218 : Generating MS Graph Dat

  24. In Figure 218, specify the Username and Password of the global administrator. If the eG agent will be communicating with Office 365 via a Proxy server, then configure the Host IP and Port number of the Proxy server. If the Proxy server requires authentication, then provide a valid Username and Password for the Proxy user. Then, in the O365 MS Graph Details section, mention the App name. This should be the same name you gave the app in step 4 above. Then, specify the Client ID and Client secret for the app. The Client ID should be the Application (client) ID you made a note of in step 5 above (see Figure 200). The Client secret should be the key that is generated and assigned to the client secret in step 8 above (see Figure 203). Finally, click the OK button.
  25. If the MS Graph Dat file is created successfully, a message to that effect will appear.