Skip to content
English
  • There are no suggestions because the search field is empty.

Search Configuration for Azure Files

Before you start. This page assumes you have already set up your Azure Files source for analysis, as described in Configure Shinydocs Pro Control Center for Azure Files (Azure file share). That page includes these Search steps, so if you followed all of it, Search is already set up.

Search can check each person’s Azure Files permissions. People sign in to Microsoft from Search, and see only results they have access to. Search uses a client secret, redirect URIs and delegated permissions on the same app registration you created for analysis.

Create a client secret

In the Azure portal, open the Shinydocs Pro app registration and select Certificates & secrets, then the Client secrets tab.

  1. Click + New client secret
    1. In the Add a client secret panel, add a description of your choice
    2. Set it to expire in 12 months or longer.
      This is a good time to schedule a reminder for the expiry, as Shinydocs Pro will also need the new secret key when this one expires.
    3. Click Add.
    4. Copy the secret key to a safe location, as you will not be able to retrieve it later.
Add redirect URIs

Still in the Azure portal Shinydocs application registration, now you will set up the redirect URIs for authentication.

  1. Navigate to the Authentication tab in the application registration Unknown Attachment
  2. Web > Redirect URIs
    1. This set up will be for the server running Shinydocs Pro Search using it’s hostname. You can update these settings later when/if you set up your fully qualified domain name in your DNS.
    2. Redirect URIs (Web platform):
      1. https://<shinydocs pro server host name>:9701/oauth/authorized
        1. e.g. https://shinyvm:9701/oauth/authorized
        2. If users reach Control Center by its full domain name, add that as well, e.g. https://shinyvm.contoso.com:9701/oauth/authorized
      2. https://localhost:9701/oauth/authorized
      Each URI must exactly match the source’s Redirect URL with /oauth/authorized added. Include the port, unless your DNS or proxy removes it.
Add API permissions

Now that the Shinydocs Application has been registered with Azure, it’s time to apply permissions to access content within Azure Files.

  1. From the sidebar menu, select API permissions Unknown Attachment
  2. Select + Add a permission Unknown Attachment
  3. Select Microsoft Graph: Unknown Attachment
  4. Then, select Delegated permissions Unknown Attachment
  5. Add the following delegated permissions
    1. User.Read
      Type: Delegated
    2. offline_acccess
      Type: Delegated
    3. openid
      Type: Delegated
    4. profile
      Type: Delegated
  6. Click Add permissions
  7. Select + Add a permission again
  8. Select APIs my organization uses and search for Azure Storage Unknown Attachment
  9. Then, select Delegated permissions and check the box for user_impersonation Unknown Attachment
  10. Click add permissions.
  11. Select Grant admin consent for [tenant], confirm when prompted
Turn on Search sign-in in Control Center
  1. Go to Sources, find the group for the connection, and select Edit. You can also go to Settings > Connections, choose the connector, and select Edit connection.
  2. Search Authentication Type: select Protected - OAuth2, then fill in: Unknown Attachment
    • Client Id: the Application (client) ID from your app registration.
    • Client Secret: the client secret from your app registration.
    • Login/Authorize Endpoint and Token Endpoint: replace common with your Tenant ID, for example https://login.microsoftonline.com/<tenant-id>/oauth2/v2.0/authorize and .../oauth2/v2.0/token.
    • Redirect URL: the address users reach Shinydocs Search on, as domain and port only, for example https://search.contoso.com:9701. https://localhost:9701 works for testing on the server itself. /oauth/authorized is added automatically. This URL with /oauth/authorized must match a redirect URI on the app registration in Microsoft Entra ID exactly.
  3. Select Save changes. Control Center checks the connection through an agent before saving, so an agent must be running. It doesn’t check the Client Secret, so sign in to Search afterwards to make sure it works.
Change the Search client secret

If the source uses Protected - OAuth2 for Search, replace its Client secret under Search Authentication Type in the same dialog as above. Control Center doesn’t check this secret when you save, so sign in to Search afterwards to make sure it works.