Microsoft Search Calendar

• About

• Set Azure Active Directory Authentication

• Client ID Requirements

• How to Add the Microsoft Search Events Backend to SmartHub

• How to Register an App in Azure and Configure It

• Limitations

 

About

Microsoft Search Events search engine uses the Graph API to:

• 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:

• Microsoft Graph
  • Calendar.Read
  
  
  

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. Click Add New Search Engine. The search engine dialogue box appears.
3. Type: Select Regular.
4. Search Engine: Select MS Search Calendar from the drop-down list.
5. Name: Enter a name for your search engine.
   
6. Graph URL: Enter the Graph URL. For example, https://graph.microsoft.com.
   
7. Authentication: Select whether to enable or disable Impersonate 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.

      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. 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
      • Calendars.Read
        
        
        
6. Click Certificates & secrets > New client secret to generate a client secret key.
   
7. In the window that appears, 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

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

• Refiners are not supported.