Microsoft Search Events

About

Microsoft Search Drive Items backend uses the Graph APIto:

  • Search for events in a user’s primary calendar

Set Azure Active Directory Authentication

Set authentication to Azure Active Directory in SmartHub as described here: Azure Active Directory Authentication.

Client ID Requirements

Additionally, the Client ID specified in Azure Active Directory Authentication, must belong to an application with the following permissions:

  • Azure Active Directory Graph
    • User.Read
  • Microsoft Graph
    • Files.Read
    • Files.Read.All


 

How to Add the Microsoft Search Events Backend to SmartHub

Use the following instructions to add the Microsoft Search Events backend to SmartHub:

  1. Navigate to the SmartHub Administration page:http(s)://[web-app-url]/_admin

  2. ClickAdd New Backend.

  3. The backend dialogue box appears.

  4. Enter a backend name.

  5. Select the backend type "MSSearchEventsBackend".

  6. Enter Graph Url: example: https://graph.microsoft.com

  7. Authentication
    1. Impersonate - true
      1. Security trims the results using the current user running the search
    2. Impersonate - false
      1. Client Id: Enter the Application ID from Azure App Registrations.
      2. Client Secret: Enter the Key's value from Azure App Registrations.
      3. Microsoft Login Endpoint: example: https://login.microsoftonline.com
      4. Access Token: Enter the access token from SmartHub's OAuth page.
      5. Refresh Token: Enter the refresh token from SmartHub's OAuth page.

In order to get AccessToken and Refresh token, "Authorize" button must be clicked, but it needs all above fields to be completed (GraphUrl, ClientId, ClientSecret, MicrosoftLoginEndpoint).

      8. ClickOK.

How to Register an App in Azure and Configure It

If you use SmartHub with Azure Active Directory authentication you can reuse the same App and jump to step 5.

  1. Navigate to portal.azure.comand log in.

  2. From the left side menu go toAzure Active Directory → App registrations → New registration
    • Name: Enter the name of the application.
    • Application type: Select Web app / API.
    • Sign-on URL:Enter the SmartHub's URL.



  3. SelectAPI Permissionsto open the settings menu panel.

  4. ClickAdd a Permission.
  5. SelectAPIs my organization usesand add the following permissions (as you type the name, it appears):
    1. Azure Active Directory Graph
      • User.Read
    2. Microsoft Graph
      • Calendars.Read.All
      • Files.Read.All
      • Files.ReadWrite.All
      • Sites.Read.All
      • Sites.ReadWrite.All

     

  6. ClickCertificates & secrets>New client secretto generate a client secret key.

  7. In the window that appears (shown below) enter the following information.
    1. Description:Enter a name for the client secret. (Note: The nameisyour client secret).
    2. Expires:Select the period until expires.



    3. A Value is generated after you clickAdd.

Metadata

The following metadata is available for your results:

  • rank
  • summary
  • @odata.type
  • hasAttachments
  • isAllDay
  • sensitivity
  • subject
  • type
  • end
  • start

Limitations

Refiners are not supported by the Microsoft Search Events backend.