Box
Go to your Box developer console:
Under MyApps, click on the 'Create New App' button
Under 'Lets Get Started' - Select Custom App
Under 'Authentication Method' - Select Server Authentication (with JWT) and click Next
Name your application e.g. 'd4iConnector' and click 'Create App'
Click 'View Your App' and navigate to the 'Configuration' tab
Under Application Scopes select the following options:
- Read all files and folders stored in Box
- Write all files and folders stored in Box
- Manage users (allows App users to be created)
- Note: if you want to script out and create app users without docuflow, this setting is not require
- Also: This setting can be used for the application to create the app users, and once the process is complete, it can be removed
Under Advanced Features select the following options
- Make API calls using the as-user header (allows scaling across app users)
- Generate user access tokens
Under Add and Manage Public Keys select 'Generate a Public/Private Keypair' and Save the json file somewhere secure. This JSON will be required for the Box Connection configuration. This private key cannot be regenerated and must be stored safely and securely.
Under App Settings select the 'Download JSON' - this JSON file is required for the Box connector
After completing these steps go to the 'App Authorization' and click 'Submit for Authorization'
Return to the Admin console, go to 'Apps' -> Custom Apps
- Click 'Authorize New App' and then enter the Client ID from the previous step
- Click the Authorize button
There are two types of connections supported for connecting to Box: Enterprise and AppUser. When creating a new Box connection this can be selected in the 'connection type' dropdown.
The Enterprise connection uses the default servcice account for connecting to Box.
The following information is required when creating a new Enterprise connection:
- Enterprise ID: This can be found in the Box Admin under the Account and Billing section
- Client ID: This can be found in the OAuth 2.0 Credentials section of the Box Enterprise Application configured earlier
- Client Secret: This can be found in the OAuth 2.0 Credentials section of the Box Enterprise Application configured earlier
- Public Key ID: This can be found in the Add and Manage Public Keys section of the Box Enterprise Application configured earlier
- Private Key: This is the Private Key that corresponds to the Public key that was registered with the Box Enterprise Application. Must be entered properly formatted with multiple lines (not only one long line).
- Passphrase: This is the passphrase for the Key registered with the Box Enterprise Application.
The AppUser connection uses a defined set of AppUsers associated with the Box Enterprise Application to conenct to Box. The d4i Box connector will round robin between the provided App Users configured in the connector.
The following information is required when creating a new AppUser connection:
- AppUser List: A list of Box App users that have been previously created under the Box Enterprise Application
- Enterprise ID: This can be found in the Box Admin under the Account and Billing section
- Client ID: This can be found in the OAuth 2.0 Credentials section of the Box Enterprise Application configured earlier
- Client Secret: This can be found in the OAuth 2.0 Credentials section of the Box Enterprise Application configured earlier
- Public Key ID: This can be found in the Add and Manage Public Keys section of the Box Enterprise Application configured earlier
- Private Key: This is the Private Key that corresponds to the Public key that was registered with the Box Enterprise Application. Must be entered properly formatted with multiple lines (not only one long line).
- Passphrase: This is the passphrase for the Key registered with the Box Enterprise Application.
Once a connection is created, a connection test can be run to check if the configuration is valid.
