What is the Box Platform? #
Box Platform is a cloud-based content management system for managing, sharing, and collaborating on digital files. Box Platform provides security, analytics, and other features related to files and information. Box Platform also includes add-ons for different industries and situations.
Why Should You Use the Box Connector? #
The Box connector provides visibility into the assets managed by Box. You can use this visibility to:
-
ensure assets are managed per your security policies
-
monitor each file and application and its status
How Does This Connector Work? #
Lucidum executes read-only requests to the Box REST API and ingests only meta-data about Box devices. Lucidum does not retrieve any data stored on your assets.
Configuring the Connector in Lucidum #
| Field | Description | Example |
|---|---|---|
| URL | URL for the Box API | api.box.com |
| Box Platform enterprise ID | Account ID for Box Platform. For details, see Creating an Application for Lucidum and Grabbing Credentials. | 578390224 |
| Client ID | A unique ID that allows API access from Lucidum to the Box Platform REST API. For details, see Creating an Application for Lucidum and Grabbing Credentials. | a65bc3t0e9dqlz5ovjof78guk9b3gil0 |
| Client Secret | A unique key that allows API access from Lucidum to the Box Platform REST API. For details, see Creating an Application for Lucidum and Grabbing Credentials. | ************ |
Source Documentation #
Creating an Application for Lucidum and Grabbing Credentials #
-
Log in to the Box developer console. For example, https://company_name.app.box.com/developers/console, as Admin.
-
Select My Apps.
-
In the My Apps page, select Create New App.
-
In the Create New App page, select Custom App.
-
In the Custom app modal page, select Select Serve Authentication (Client Credentials Grant). Provide a name for the app (Lucidum) in the App Name field. Click Create App.
-
Go to My Apps. Click the menu (…) for the new app. Click the Configuration tab.
-
In the Configuration tab, select the access level and scopes as below:
-
App Access Level. Select App + Enterprise Access.
-
Application Scopes. Select:
-
Write all files and folders stored in Box
-
Manage Users
-
Manage groups
-
Manage enterprise properties
-
Manage webhooks
-
Enable integrations
-
Manage Box Relay
-
-
-
Copy and save the Client ID. Click Fetch Client Secret. Copy and save the Client Secret. You need these values to configure the Box connector in Lucidum.
-
Select the General Settings tab
-
Copy the Enterprise ID. You need these values to configure the Box connector in Lucidum.
-
Click the Authorization tab. Click Review and Submit to send to your Box administrator for approval.
Required Permissions #
| Object | Access Level |
|---|---|
| Client ID | App + Enterprise Access |
| Object | Application Scopes |
|---|---|
| Client ID | Write all files and folders stored in Box Manage Users Manage groups Manage enterprise properties Manage webhooks Enable integrations Manage Box Relay |
