Box Prerequisites¶
Introduction¶
These are the prerequisites for using the Box connector:
- An authorized Box custom app with JWT authenticaton. Creation of a JWT app requires a Box business plan.
- The
clientID
,clientSecret
,publicKeyID
,privateKey
, andpassphrase
from the JSON file automatically downloaded during app creation. - The user ID associated with the app.
Instructions¶
These are the instructions for creating a custom app and obtaining the required information for a successful Box connection.
-
Create a Box custom app with JWT authentication:
- Generating a keypair is required. The JSON file that is automatically downloaded after keypair generation contains the
clientID
,clientSecret
,publicKeyID
,privateKey
, andpassphrase
information (required during connection configuration). -
Authorizing the custom app is required.
Note
This may require that you configure 2-step verification in your Box account.
-
For Application Access in the app's Configuration tab, select App + Enterprise Access.
-
For Application Scopes in the app's Configuration tab, ensure the following are enabled:
- Read all files and folders stored in Box
- Write all files and folders stored in Box
- Manage users
- Manage groups
- Manage enterprise properties
- Enable integrations
-
For Advanced Features in the app's Configuration tab, enable Make API calls using the as-user header and Generate user access tokens.
- Generating a keypair is required. The JSON file that is automatically downloaded after keypair generation contains the
-
Retrieve the user ID associated with the app:
- Navigate to the app's General Settings tab. The User ID is visible in App Info.