Overview
This collector pulls events from the Box API, which pulls from admin activities endpoint.
Devo collector features
Feature | Details |
|---|---|
Allow parallel downloading ( |
|
Running environments |
|
Populated Devo events |
|
Flattening preprocessing |
|
Allowed source events obfuscation |
|
Data sources
Data source | API endpoint | Collector service name | Devo table |
|---|---|---|---|
Admin |
|
|
|
For more information on how the events are parsed, visit our page.
Vendor setup
To log in to the Box environment. Using the vendor doc here:
Enable the Box API Playground
Navigate to the Developer Console Log into Box and go to the Developer Console. Select Create New App.
Select application type Select Custom App from the list of application types. A modal will appear to prompt a selection for the next step.
Provide basic application information
Purpose | Details |
|---|---|
Automation, Custom Portal | Specify if the app is built by a customer or partner. |
Integration | Specify the integration category, external system name if the app is built by a customer or partner. |
Other | Specify the app purpose and if it is built by a customer or partner. |
Select application authentication Select Server Authentication (with JWT) if you would like to verify application identity with a key pair and confirm with Create App. Once created you will not be able to change it
Public and private key pair Once a Custom App is created leveraging Server Authentication with JWT, a key pair can be generated via the configuration tab within the Developer Console. Alternatively, you can generate your own and supply Box with the public key. Regardless of the method you select, your Box account will need to have 2FA enabled for security purposes.
Generate a keypair (Recommended) If you would like to use a Box generated keypair, navigate to the Developer Console where you can generate a configuration file. This file includes a public/private keypair and a number of other application details that are necessary for authentication.
To generate this file, navigate to the Configuration tab of the Developer Console and scroll down to the Add and Manage Public Keys section. Once this step is completed a File will be downloaded, this is the information you will use to copy to your Collector in the Self Service Application.
App Authorization Before the application can be used, a Box Admin needs to authorize the application within the Box Admin Console.
Navigate to the Authorization tab for your application within the Developer Console. Your Box Admin will need to authorize this. Once completed your app is ready to use.
Minimum configuration required for basic pulling
Although this collector supports advanced configuration, the fields required to retrieve data with basic configuration are defined below.
This minimum configuration refers exclusively to those specific parameters of this integration. There are more required parameters related to the generic behavior of the collector. Check setting sections for details.
Setting | Details |
|---|---|
| The Box client ID |
| The Box client secret |
| The Box Public Key Id |
| The Box Private Key |
| Box Passphrase |
| The Box Account Enterprise ID |
Accepted Authentication Methods
Authentication Method | Client ID | Client Secret | Public Key Id | Private Key | Passphrase | Enterprise Id |
|---|---|---|---|---|---|---|
JWT | Required | Required | Required | Required | Required | Required |
Run the collector
Once the data source is configured, you can either send us the required information if you want us to host and manage the collector for you (Cloud collector), or deploy and host the collector in your own machine using a Docker image (On-premise collector).
Collector services detail
This section is intended to explain how to proceed with specific actions for services.
Collector operations
Change log
Release | Released on | Release type | Recommendations |
|---|---|---|---|
|
| NEW FEATURE |
|