Microsoft Search Items

 

About

Microsoft Search OneDrive search engine uses the Graph APIto:

  • Send search queries to Microsoft 365
  • Receive files stored in SharePoint or OneDrive
  • Query the following resource types, which are configured at the backend level:
    • driveItem
    • list
    • listItem
    • site
    • externalItem

Set Azure Active Directory Authentication

You can set your authentication to Azure Active Directory in SmartHub as described here: Azure Active Directory Authentication.

Application Permissions

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

  • Microsoft Graph
    • Files.Read.All
    • Sites.Read.All


How to Add the Microsoft Search Items search engine to SmartHub

Use the following instructions to add the Microsoft Search Drive Items backend to SmartHub:

  1. Navigate to the SmartHub Administration page: http(s)://[web-app-url]/_admin
  2. Click Add New Backend. The Search Engine dialogue box appears.
  3. Type: Select Regular.
  4. Search Engine: Select MS Search Items from the drop-down list.
  5. Name: Enter a name for your search engine.
  6. Entity Types: Select any of the following entity types that you want to query for:
    • driveItem
    • list
    • listItem
    • site
    • externalItem
  7. Connector Connection Id(only for external item): Enter the connection ID associated with your content. 
    • To get the connector Connection ID, do the following:
      • Go to the Office Admin page.
      • Click Settings > Microsoft Search.
      • Click Connectors. A list of your current connectors appears with their connection IDs.
        • The connection ID value is the parameter the search engine expects to receive.

  8. Graph Url: This is the URL of your Microsoft Graph instance. For example, https://graph.microsoft.com/.
  9. Authentication Select whether to enable or disable Impersonate authentication:
    1. Impersonate enabled
      1. Security trims the results using the current user running the search
    2. Impersonate disabled
      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.

Note: To get the Access and Refresh tokens, the "Authorize" button must be clicked, but all the above fields must be completed (GraphUrl, ClientId, ClientSecret, MicrosoftLoginEndpoint).

      8. Click OK.

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. To register and configure an app in Azure, do the following:

  1. Navigate to portal.azure.comand log in.
  2. From the left side menu go to Azure 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. Select API Permissions to open the settings menu panel.
  4. Click Add a Permission.
  5. Select APIs my organization uses and add the following permissions (as you type the name, it appears):
    1. Microsoft Graph
      • Files.Read.All or Sites.Read.All


  1. Click Certificates & secrets>New client secret to generate a client secret key.
  2. In the window that appears (shown below) enter the following information.
    1. Description: Enter a name for the client secret. (Note: The name is your client secret).
    2. Expires: Select the period until expires


    3. A Value is generated after you click Add.

Metadata

The following metadata is available for your results:

  • rank
  • summary
  • @odata.type
  • lastModifiedDateTime
  • createdDateTime
  • webUrl
  • createdBy
  • name
  • size
  • lastModifiedBy

Note: For some types, not all metadata is available

Limitations

Note the following limitations when using the Microsoft Search OneDrive search engine:

  • Date refiners are not supported.

  • Result sorting is not supported for external items.