Documentation

View Categories

Manual

Pre-configuration Steps #

Note #

Box uses OAuth 2.0 for authentication and authorization. To allow the Box connector to collect data via Box APIs, follow the pre-configuration steps to configure an app in the Box Developer Console.

Refer this doc for more details and additional reference information.

  • Log in to Box developer console with an admin account. Account with Admin role is preferable to get full access to all metadata and enterprise events.
  • Create a Custom App > Select Integration as the purpose > Choose User Authentication (OAuth 2.0)
  • Set Redirect URI – https://dataelicit.com/callback
  • Enable the following Application Scopes:
    • Read all files and folders stored in Box – Gets data of Folders endpoint ( Collect folder metadata, Collect folder collaboration, Collect file metadata).
    • Read and write all files and folders in Box – Gets data of Folders endpoint (Collects tasks and comments).
    • Manage users – Get data of Users endpoint.
    • Manage groups – Get data of Groups endpoint.
    • Manage enterprise properties – Get data of Events endpoint.
  • Note the Client ID and Client Secret & Save changes

Note #

If the application scopes are changed after configuring your account in the Connector for Box, the Box account will have to be reconfigured in the Box Connector to generate a new token with the upgraded, and downgraded access.

Installation #

  • Login into DataElicit’s portal. Download the related LogScale package from the Packages tab.
  • Install the LogScale package into your Falcon LogScale repository.
  • Download box.tgz from the Connectors tab and extract the tar into <Installation-Path>/LogConnector/connectors directory
tar -xzf box.tgz
  • box connector directory:
/opt/LogConnector/connectors/box$ ls 
bin  default  template  manifest.yaml README.md

Configuration #

  • Create local directory and configure connector.conf, global.conf, secret.conf as per your requirements:
/opt/LogConnector/connectors/gcp$ mkdir local 
/opt/LogConnector/connectors/gcp$ cd local 
/opt/LogConnector/connectors/gcp/local$ nano connector.conf 
/opt/LogConnector/connectors/gcp/local$ nano secret.conf 
/opt/LogConnector/connectors/gcp/local$ nano global.conf 
/opt/LogConnector/connectors/gcp/local$ ls 
connector.conf  global.conf  secret.conf

Note #

Check conf specific conf.ini files in template/ directory for how to configure the conf files.

Important #

Configure the secret.conf file at the end, as it involves additional steps to obtain an authorization code from Box. This code is only valid for 30 seconds, so you must add it to secret.conf and start the connector within that time frame.

References #

https://developer.box.com/reference

https://developer.box.com/guides/api-calls/permissions-and-errors/

Scroll to Top