Illustration

Configuring the Graph API (Excel, OneDrive)

In order to communicate with Excel 365, OneDrive, and other products that are part of Office 365, we’ll use the so-called Graph API to establish a connection with GoBright View. In the steps below you’ll find all requirements for configuration.

Keep in mind that these steps can only be performed by an Azure Admin.

How does GoBright access the Excel file?

GoBright View has access to the Excel file using a service account. The Excel file can either be shared with (1) the service account or owned by (2) the service account.

  1. A user can create an Excel file somewhere in their OneDrive and then give the service account access to that file (detailed steps below).
  2. The file can be created in the OneDrive of the service account itself.

After the one time configuration any changes to the Excel fil will automatically show up in GoBright View within 5 minutes.

Requirements

  • An Office 365 admin account
  • Rights to grant API permissions
  • A Service account with OneDrive access

Within Azure

Register an application

  1. Go to portal.azure.com and log in with an admin account
  2. Go to Azure Active Directory
  3. Go to App registrations
  4. Click + New registration
    1. Give this application a name, for example: GoBright View
    2. Supported account types: Accounts in this organizational directory only (Single Tenant)
    3. Click Register
       'Register' button in Microsoft AzureAD

Create a Client Secret

  1. Open the app you’ve just registered
  2. Go to Certificated & secrets
  3. Go to Client secrets
  4. Click + New client secret
    1. Description – Give it a description
    2. Expires – set an expiration date
    3. Mark this date in your calendar and remember to renew the secret before it expires
    4. Write down the Secret Value as this is only displayed once. This value is needed within GoBright View later on. We do not need the Secret ID.
      If you missed or forgot the Secret Value, delete this Client Secret and create a new one.

Set API permissions

  1. Open the app you’ve just created
  2. Go to API permissions
  3. Client + Add a permission
  4. Select Microsoft Graph
  5. Choose Delegated permissions
  6. Add these permissions:
    1. Directory.AccessAsUser.All (Delegated)
    2. Files.Read.All (Delegated)
    3. User.Read (Delegated)
  7. Click Grant admin consent for [Azure-Domain]
  8. Go to Overview
    1. Write down the Application (client) ID
    2. Write down the Directory (tenant) ID

Create a service account

  1. Go to Azure Active Directory
  2. Go to Users
  3. Click + New user and then + Create new user
    1. Select template – Create user
    2. Identity
      1. User name – for example: gobright-view@[Azure-Domain]
      2. Name – for example: GoBright View Service Account
    3. Password
      1. Choose auto-generate password or Let me create the password
      2. Write down the password
    4. Click Create
    5. Open the user
    6. Go to Licenses
    7. Click + Assignments
      1. Select Microsoft 365 Business Basic
        This license includes OneDrive access which we need.
      2. Click Save

You should now have these pieces of information:

  1. Application (client) ID
  2. Directory (tenant) ID
  3. Client Secret Value
  4. Username of the service account
  5. Password of the service account

These were all steps that need to be performed by an Azure Admin. Please provide these credentials to the those who are continue to set this up. Refer to the following guides to continue:

Excel 365

OneDrive Slideshow

Requirements

  • An Office 365 admin account
  • Rights to grant API permissions

Within Azure

The following steps need to be taken to configure the Graph API:

Register an application

  • https://portal.azure.com/#home
  • Navigate to Azure Active Directory
  • Press App registrations
    mceclip0.png
  • Create a New registration
  • Enter a Name (e.g. GoBright View)
  • Leave the other settings to default and press the Register button on the bottom

Set permissions

  • Open the application and press the View API permissions button
    mceclip1.png
  • Press the Add a permission button and a new window will open
  • Select Microsoft Graph when prompted for an API
  • Set the type of permission to Application permissions
  • A long list of permissions will be shown, depending on which applications you’ll be using the following permissions must be granted:
    • APIConnectors.Read.All – Type: Application – For authentication
    • Application.Read.All – Type: Application – For navigation
    • Directory.Read.All – Type: Application – For navigation between different folders
    • Files.Read.All – Type: Application – Used by OneDrive
    • Reports.Read.All – Type: Application – Used by Excel
    • Sites.Read.All – Type: Application – Used by SharePoint

      Please make sure that permissions are granted as “Application” permissions.

  • When the correct permissions have been added press the Grant admin consent button
    mceclip2.png

Gather all information and create a Client secret

In order to connect with the application, GoBright View will need three pieces of information:

  • Client ID: This can be found on the overview page
  • Client Secret: Must be created within Certificates & secrets
  • Tenant ID: This Can be found on the overview page

First, let’s copy the Client ID and Tenant ID from the Overview within the application. These can be found on the top of the page:

mceclip3.png

Next is the Client Secret Value, for this, we’ll need to head to Certificates & secrets.

The Client Secret consists of an ID and a Value, we’ll need the Value.

Certificates and secrets values pictogram

  • Create a New client secret at the bottom of this page
  • You can add a description (e.g. usage within GoBright View)
  • Choose when the key expires (note: we recommend to set the expiry date to as far in the future as possible. Please also set a reminder to renew this key.
  • When the Client secret has been created immediately copy and note the Secret Value as it will only be displayed once. If you didn’t get the Value, you can delete these steps to create a new one. We don’t need the Secret ID.

That is all the information we need, next, we can use this information within the GoBright Widget.

This article comes from the Help Center of GoBright.
View original article
FAQ

Ask us anything! Find the answers to the most frequently asked questions here.

Browse the FAQ
Help center

A goldmine for all IT and Facility Managers. Dive into the technical stuff concerning our products and solutions.

Visit the help center
Newsletter

Wanna stay informed of all developments within the smart office and our new features? Subscribe now.

Subscribe now.