Shinydocs Pro
Shinydocs Pro
Breadcrumbs

Search Configuration for Box

Box™ by Box Inc. has API limits that can incur costs to your organization. While the Shinydocs Pro uses these API calls efficiently, depending on the volume of your data, you may go over your API limit. Please consult with your Box representative for more information.

Requirements

  • Access to Box URL from server running Shinydocs Pro (internet connection required)

    • Example: http://box.com 

  • Access to your organization’s Box Dev Console

  • Your account must have MFA enabled in Box to use client secret authentication


Steps

  1. Log in to Box at Box Developer Console.

  2. Go to My Platform Apps.

  3. Click Create Platform App.

  4. Select Custom App:

    image-20251015-132900.png

  5. Fill out the custom app details:

    image-20251015-133201.png

    1. App Name: Shinydocs Search

    2. Description: Integration with Shinydocs Search

    3. Purpose: Integration

    4. Categories: Productivity

    5. Which external systems are you integrating with?: Shinydocs Search

    6. Who is building this application: Partner

    7. Please specify: Shinydocs

  6. Click Next.

  7. In Step 2 of 2, select User Authentication (OAuth 2.0):

    image-20251015-133443.png

  8. Click Create App.

  9. You will now be in the Shinydocs Search app configuration

    image-20251015-133616.png

  10. Scroll down to the OAuth 2.0 Credentials section

    image-20251015-133836.png

    1. Note the Client ID and Client Secret, you will need these later.

  11. Scroll down further to OAuth 2.0 Redirect URIs

    1. Add the following URIs:

      1. https://localhost:9701/oauth/authorized

      2. https://<hostname>:9701/oauth/authorized
        Replace <hostname> with the machine name Shinydocs Pro is installed on.

      3. (optional) https://<FullyQualifiedDomainName>/oauth/authorized
        Replace <FullyQualifiedDomainName> with the machine name Shinydocs Pro is installed on.

  12. Click Save Changes in the top-right of the page.

Configure source in Shinydocs Pro Control Center

With the application registered in Box, you can now configure Shinydocs Control Center to use OAuth for real-time permission checking in Shinydocs Enterprise Search.

Either when adding a new Box source or editing and existing source (via edit button on the source image-20251015-184354.png ):

  1. 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-20251015-185151.png
    Adding a new Box source
    image-20251015-185223.png
    Adding Search configuration to an existing Box 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. Login/Authorize Endpoint: Use the default value

    5. Token Endpoint: Use the default value

    6. Revoke Token Endpoint: Use the default value

    7. Redirect URL: Start with https://<hostname>:9701
      Replace <hostname> with the machine name Shinydocs Pro is installed on

  2. Click Save changes