Microsoft Search Persons

• About

• Limitations

• Set Azure Active Directory Authentication

  • Client ID Requirements

• How to Add the Microsoft Search Persons Backend to SmartHub

• How to Register an App in Azure and Configure It

• Metadata

About

Microsoft Search Persons backend uses the Graph API to search for information about a person from mail and contacts.

Limitations

The following are limitations for the Microsoft Search Persons backend. If a feature is not supported by the Microsoft Search Graph API, it will also be not supported by a Microsoft Search Graph backend. For more information, refer to the Microsoft Graph API documentation.

• Wild querying is not supported by the Microsoft Search Persons backend.

• Refiners are not supported by the Microsoft Search Persons backend.

Set Azure Active Directory Authentication

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

Client ID Requirements

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

1. Microsoft Graph

• People.Read

• People.Read.All

How to Add the Microsoft Search Persons Backend to SmartHub

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

1. Navigate to the SmartHub Administration page: http(s)://[web-app-url]/_admin
   
2. Click Add New Backend.
3. The Backend Settings dialog box displays.
   
4. Enter a Backend Name.
   
5. Select the Backend Type "MSSearchPersonsBackend"
   
6. Authentication
   1. Impersonate - true
      1. Security trims the results using the current user running the search
   2. Impersonate - false
      1. Client Id:
         1. Enter the Application ID from Azure App Registrations.
      2. Client Secret:
         1. Enter the Key's value from Azure App Registrations.
      3. Microsoft Login Endpoint:
         1. Example: https://login.microsoftonline.com
      4. Access Token:
         1. Enter the access token from SmartHub's OAuth page.

      5. Refresh Token:

         1. Enter the refresh token from SmartHub's OAuth page.
            

         2. To get AccessToken and Refresh token, "Authorize" button must be clicked, but all above fields must be completed (GraphUrl, ClientId, ClientSecret, MicrosoftLoginEndpoint).

7. 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.

1. Navigate to portal.azure.com and log in.
   
2. From the left side menu go to Azure Active Directory > App registrations > New registration.
3. On the Register an application window, specify the following:
   
   • Name: Enter the name of the application.
   • Application type: Select Web app / API.
   • Sign-on URL: Enter the SmartHub's URL.
     
4. Select API Permissions to open the settings menu panel.
   
5. Click Add a Permission.
6. Select APIs my organization uses and add the following permissions (as you type the name, it appears):
   
   1. Microsoft Graph

      1. People.Read

      2. People.Read.All

7. Click Certificates & secrets>New client secret to generate a client secret key.
   
8. In the window that appears (shown below) enter the following information.
   
   1. Description:
      1. Enter a name for the client secret.
      2. 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:

• @data.type

• id

• displayName

• emailAddress.address
• emailAddress.rank
• personType
• userPrincipalName