OneCloud

This article has expired. Please visit the OneCloud Knowledge Base for the latest documentation.

Core 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.

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

Need a specialized command for box?

If there are specific operations that your company is looking to perform with box, please contact [email protected] to discuss the requirements and we would be happy to consider incorporating the capability into OneCloud.

Connection Setup

Box

The box BizApp connection requires the following key inputs:

Inputs

Input
Type
Detail

Client ID

TextField

The service account app client ID

Client Secret

TextField

The service account app client secret

Client Key

TextField

The service account decrypted RSA key

Enterprise ID

TextField

The service account enterprise ID

Connection Example

Creating a box application

The following will create a Service Account integration for box

  1. In the developer console for your box account, select Create New App > Custom App.
  2. When prompted to choose an authentication method, select OAuth 2.0 with JWT (Server Authentication).

Configuring a box application

Step #1 - box developer console:

  • Set Authentication Method is set to OAuth 2.0 with JWT (Server Authentication).
  • Set Application Access is set to Enterprise.
  • Set Add and Manage Public Keys includes the generated public key (see below section for creating an RSA key pair and manually add key).

Step #2 - box admin console:

  • Please follow the instructions for box admin console help and ensure Custom Application includes your application with All Users in access.

Creating an RSA key pair

You can generate the necessary RSA key pair using the openssl utility. The below commands show you how to generate the correct key pair. The output file called private.pem is the private key that you'll add to your box BizApp connection in OneCloud. The public.pem file is the public key that you'll add to your box app configuration in the developer page for box.

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

Creating the box BizApp connection

  • Set the clientID to the client ID found in the Configuration > OAuth 2.0 Credentials page for your box app
  • Set the clientSecret to the client secret found in the Configuration > OAuth 2.0 Credentials page for your box app
  • Set the clientKey to the value generated in private.pem
  • Set the enterpriseID to the enterprise ID found in the General page for your box app

Updated 6 days ago

box


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.