Shinydocs Pro
Shinydocs Pro
Breadcrumbs

Search Configuration for Microsoft Connectors

App Registration & API Permissions

To configure Shinydocs Pro Search, you need to register the app in Azure and set the necessary API permissions. Shinydocs Search is designed to use a single Microsoft app registration for all supported Microsoft connectors. This simplifies management and ensures streamlined integration across different connectors.

You should create one app registration for Shinydocs Search and then add the appropriate permissions based on the specific Microsoft connector(s) you intend to use, such as SharePoint, OneDrive, or Teams.

Step 1: Create the App Registration

  1. Log in to the Azure portal as an administrator.

  2. Navigate to Azure Active Directory > App registrations.

  3. Click New registration.

  4. Enter a name for the app (e.g., "Shinydocs Pro Search").

  5. For Supported account types, select Accounts in this organizational directory only.

  6. In the Redirect URI section, select Web and enter http://[server]:9702/azuread/success (you can update this later). Replace [server] with your server name or FQDN.

    1. You can have multiple values for the redirect

    2. If using an FQDN, you likely will not need the port information.

  7. Click Register.

Step 2: Generate a Secret Key

  1. In the app registration, go to Certificates & secrets.

  2. Click New client secret.

  3. Add a description (e.g., "Shinydocs Pro Key") and select an expiration period.

  4. Click Add.

  5. Copy the secret value and store it securely. You will not be able to view it again.

Step 3: Take notes

From the application registration, you will need the following values later in Shinydocs Control Center:

  • Client ID

    • e.g. 1fe2bcf8-e077-4e47-8bc3-271cd934636e

  • Client Secret Key

    • e.g. _rQ65~XwQ0u-G4_auC2u2HG9TunplKo.N1iyGa0w

  • Your Microsoft Tenant ID

    • e.g. 42abc123-a76a-4j03-bf1e-4e51c696d65d

  • The redirect URL

Step 4: Connector specific

The following are steps for each respective connection type you are analyzing:

Microsoft SharePoint Online

Microsoft SharePoint Online Set API Permissions

To allow Shinydocs Pro Search to access SharePoint Online and perform searches, configure API permissions.

Configure Microsoft Graph Permissions

  1. In the app registration, go to API permissions.

  2. Click Add a permission.

  3. Select Microsoft Graph > Delegated permissions.

  4. Grant the following delegated permissions:

    • offline_access

    • openid

    • profile

    • User.Read

    • Sites.Read.All

  5. Click Add permissions.

Configure SharePoint Permissions

  1. In API permissions, click Add a permission.

  2. Select SharePoint > Delegated permissions.

  3. Grant the following permission:

    • AllSites.Read: Allows the app to view any sites and their contents the signed-in user has access to. This enables permissions checks during searches.

  4. Click Add permissions.

  5. Click Grant admin consent for _____ to apply the permissions.

If you are configuring a seperate application registration for Search, seperate from Shinydocs Pro Control Center (crawling), your permissions should look like this. If you are using the same application registration, these permissions are in addition to your existing entries.

image-20241219-211807.png

Shinydocs Control Center Configuration

With the introduction of Shinydocs Streamlined Search, which is now part of Shinydocs Control Center, search configuration is now performed in the Sources page of Control Center.

You can choose this setting when creating a source, or update it later by editing the connection from the Sources page (see images below).

image-20250704-190202.png
Configure search with a new source
image-20250703-182520.png
Configure search with an existing source

  1. Either in Edit connection or Add source, select Protected - OAuth2 in Search Authentication Type

  2. Enter the Client ID from your application registration

  3. Enter the Client Secret (key) from your application registration

  4. For Login/Authorize Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/authorize

  5. For Token Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/token

  6. Click Save changes

Microsoft Exchange Online

Microsoft Exchange Online Set API Permissions

To allow Shinydocs Pro Search to access SharePoint Online and perform searches, configure API permissions.

Configure Microsoft Graph Permissions

  1. In the app registration, go to API permissions.

  2. Click Add a permission.

  3. Select Microsoft Graph > Delegated permissions.

  4. Grant the following delegated permissions:

    • Directory.AccessAsUser.All

    • email

    • EWS.AccessAsUser.All

    • Files.Read.All

    • Group.Read.All

    • Mail.Read.All

    • Mail.Read.Shared

    • offline_access

    • openid

    • profile

    • User.Read

  5. Click Add permissions

  6. Click Grant admin consent for _____ to apply the permissions.

Your API permissions should look like this

image-20241220-203520.png

Shinydocs Control Center Configuration

With the introduction of Shinydocs Streamlined Search, which is now part of Shinydocs Control Center, search configuration is now performed in the Sources page of Control Center.

You can choose this setting when creating a source, or update it later by editing the connection from the Sources page (see images below).

image-20250704-190202.png
image-20250703-182520.png

  1. Either in Edit connection or Add source, select Protected - OAuth2 in Search Authentication Type

  2. Enter the Client ID from your application registration

  3. Enter the Client Secret (key) from your application registration

  4. For Login/Authorize Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/authorize

  5. For Token Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/token

  6. Click Save changes

Microsoft OneDrive

Microsoft OneDrive Set API Permissions

To allow Shinydocs Pro Search to access SharePoint Online and perform searches, configure API permissions.

Configure Microsoft Graph Permissions

  1. In the app registration, go to API permissions.

  2. Click Add a permission.

  3. Select Microsoft Graph > Delegated permissions.

  4. Grant the following delegated permissions:

    • offline_access

    • openid

    • profile

    • User.Read

    • Files.Read.All

    • Directory.Read.All

  5. Click Add permissions

  6. Click Grant admin consent for _____ to apply the permissions.

Shinydocs Control Center Configuration

With the introduction of Shinydocs Streamlined Search, which is now part of Shinydocs Control Center, search configuration is now performed in the Sources page of Control Center.

You can choose this setting when creating a source, or update it later by editing the connection from the Sources page (see images below).

image-20250704-190202.png
image-20250703-182520.png

  1. Either in Edit connection or Add source, select Protected - OAuth2 in Search Authentication Type

  2. Enter the Client ID from your application registration

  3. Enter the Client Secret (key) from your application registration

  4. For Login/Authorize Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/authorize

  5. For Token Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/token

  6. Click Save changes

Microsoft Teams

Microsoft Teams Set API Permissions

To allow Shinydocs Pro Search to access SharePoint Online and perform searches, configure API permissions.

Configure Microsoft Graph Permissions

  1. In the app registration, go to API permissions.

  2. Click Add a permission.

  3. Select Microsoft Graph > Delegated permissions.

  4. Grant the following delegated permissions:

    • offline_access

    • openid

    • profile

    • User.Read

    • Files.Read.All

    • Sites.Read.All

    • Directory.Read.All

    • Channel.ReadBasic.All

    • ChannelMember.Read.All

    • Chat.Read

    • Group.Read.All

    • Team.ReadBasic.All

    • TeamSettings.Read.All

  5. Click Add permissions.

  6. Click Add permissions

  7. Click Grant admin consent for _____ to apply the permissions.

Shinydocs Control Center Configuration

With the introduction of Shinydocs Streamlined Search, which is now part of Shinydocs Control Center, search configuration is now performed in the Sources page of Control Center.

You can choose this setting when creating a source, or update it later by editing the connection from the Sources page (see images below).

image-20250704-190202.png
image-20250703-182520.png

  1. Either in Edit connection or Add source, select Protected - OAuth2 in Search Authentication Type

  2. Enter the Client ID from your application registration

  3. Enter the Client Secret (key) from your application registration

  4. For Login/Authorize Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/authorize

  5. For Token Endpoint, replace “common” with your Tenant ID

    1. e.g. https://login.microsoftonline.com/42abc123-a76a-4j03-bf1e-4e51c696d65d/oauth2/v2.0/token

  6. Click Save changes

Try it out!

You can test that permissions are working by trying a search in Streamlined Search. To do so, click the Search icon in Shinydocs Control Panel or go to https://servername:9701/search.

  1. Verify your current account by clicking on the burger menu in the top left

    image-20250704-192313.png

    1. The side panel will slide over revealing your sources and the account you are currently logged in as

      image-20250704-192429.png

  2. You will notice that Microsoft SharePoint Online is grey - click the connection on the left to launch the OAUTH login. Sign in with your credentials.

    image-20250704-192605.png

  3. Once you are successfully connected, you will see the icon light up in color!

    image-20250704-192821.png

  4. Perform a search for content you know you have access to. Try an exact file name if you can. You will see results if everything was configured properly

    image-20250704-193113.png
    Example of permissioned results from Microsoft SharePoint Online


  5. Congratulations! You are ready to start searching!