Help Desk

Submit a ticket My Tickets
Welcome
Login

Box BizApp


Premium BizApp

The OneCloud box BizApp enables OneCloud to interact with box drives to perform various tasks such as upload, download, move, search and delete files as well as create and delete folders and fetch the file and folder URLs.

Connection Setup

View the box connection parameters.

Connection Example

Creating a box application

The following will create a box Service Account integration:

  1. Login to Box at https://app.box.com
  2. From within the box web application, select the Dev Console which is also accessible directly through https://app.box.com/developers/console.
  3. From within the Dev Console, select Create New App.
  4. Select Custom App and then click Next.
  5. When prompted to choose an authentication method, select OAuth 2.0 with JWT (Server Authentication).
  6. Provide a unique Box app name (e.g., OneCloud Box App) and select Create App.
  7. After the successful creation of your app, select View Your App.

Configure a box application

The Box app configuration interface provides many configuration options. For OneCloud, the following options will need to be set. 

  1. Set Authentication Method to OAuth 2.0 with JWT (Server Authentication).
  2. Set Application Access to Enterprise.
  3. Click Save Changes

The Box will also require a public key that is paired with a private key that will be used in the configuration of the OneCloud Box Connection. 

  1. Scroll to the section Add and Manage Public Keys.
  2. Select Add a Public Key.  Adding a public key requires Box two factor authentication (2FA) to be enabled.  If 2FA is not enabled, a warning with a link to settings will be displayed.  Be sure to enable 2FA. 
  3. Add a Public Key. Follow the instructions for Creating an RSA key pair below.
  4. Open the file public.pem with a text editor such as Windows notepad.exe. Do not use an editor like Microsoft Word
  5. Copy and paste the contents of the file to the Add a new Public Key interface. Be sure to include the header line -----BEGIN PUBLIC KEY----- as well as the footer line -----END PUBLIC KEY----- taking care to include any extra spaces before or after.  Click Verify and Save. You will be prompted to enter the 2FA code. Specify the code and Submit
  6. Once the key has been added, it will be displayed similar to this example:
  7. Return to the primary Box application (https://app.box.com) by clicking the Admin Console link.
  8. Navigate to Apps.
  9. Navigate to Custom Apps and select Authorize New App.
  10. Copy the Client ID found on the Configuration page for the Box app into the App Authorization window and click Next.
  11. Authorize for All Users.
  12. The new application will appear:

To learn more about managing custom apps, see Box's documentation.

Creating an RSA key pair

Generate the necessary RSA key pair using the OpenSSL utility. If this utility is not available, then please install it from this site. The commands below show you how to generate the correct key pair. 

openssl genrsa -out private.pem 2048
openssl rsa -in private.pem -outform PEM -pubout -out public.pem

The output file, private.pem, contains the key that will be added to the OneCloud Box BizApp Connection. The contents of the public key file, public.pem, will be added to the Box custom app configuration in the developer page for Box.

Creating the Box BizApp connection in OneCloud

  1. Create a new OneCloud Connection and select Box.
  2. Set the Client ID field in the Connection to the Client ID value found on the Configuration page for the Box app.
  3. Set the Client Secret in the Connection to the Client Secret value found on the same page as the previous step. The following example illustrates where the two values can be retrieved.
  4. Set the Client Key field in the Connection to the private key in the private.pem file. Note that this will be similar to step #5 in section for configuring the Box application and should include the -----BEGIN RSA PRIVATE KEY----- header line and -----END RSA PRIVATE KEY----- footer lines and should also include any trailing spaces as with the public key.
  5. Set the Enterprise ID field in the Connection to the Enterprise ID found in the General page for the Box app.

What's Next?

For documentation on all available Commands, see the box Command Reference.

B
Brian is the author of this solution article.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.