The Elastic Box connector is built with the Elastic connector framework and is available as a self-managed connector client.
Availability and prerequisitesedit
This connector is available as a self-managed connector client. To use this connector, satisfy all connector client prerequisites.
This connector is in technical preview and is subject to change. The design and code is less mature than official GA features and is being provided as-is with no warranties. Technical preview features are not subject to the support SLA of official GA features.
To use this connector as a connector client, use the Box tile from the connectors list OR Customized connector workflow.
For additional operations, see Using connectors.
Box API Authorizationedit
Box Free Accountedit
Create Box User Authentication (OAuth 2.0) Custom Appedit
You’ll need to create an OAuth app in the Box developer console by following these steps:
- Register a new app in the Box dev console with custom App and select User authentication (OAuth 2.0).
- Add the URL of the web page in Redirect URIs, which is accessible by you.
- Check "Write all files and folders stored in Box" in Application Scopes.
- Once the app is created, Client ID and Client secret values are available in the configuration tab. Keep these handy.
Generate a refresh Tokenedit
To generate a refresh token, follow these steps:
Go to the following URL, replacing
<CLIENT_ID>with the Client ID value saved earlier. For example:
- Grant access to your application.
- You will now be redirected to the web page that you configured in Redirect URIs, and the HTTP response should contain an authorization code that you’ll use to generate a refresh token. Note: Authorization codes to generate refresh tokens can only be used once and are only valid for 30 seconds.
In your terminal, run the following
<CLIENT_ID> and <CLIENT_SECRET>with the values you saved earlier:
curl -i -X POST "https://api.box.com/oauth2/token" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "client_id=<CLIENT_ID>" \ -d "client_secret=<CLIENT_SECRET>" \ -d "code=<AUTHORIZATION_CODE>" \ -d "grant_type=authorization_code"
Save the refresh token from the response. You’ll need this for the connector configuration.
Box Enterprise Accountedit
Create Box Server Authentication (Client Credentials Grant) Custom Appedit
- Register a new app in the Box dev console with custom App and select Server Authentication (Client Credentials Grant).
Check following permissions:
- "Write all files and folders stored in Box" in Application Scopes
- "Make API calls using the as-user header" in Advanced Features
App + Enterprise Accessin App Access Level.
- Authorize your application from the admin console. Save the Client Credentials and Enterprise ID. You’ll need these to configure the connector.
Dropdown to determine Box Account type:
Box Free Accountor
Box Enterprise Account. Default value is
Box Free Account.
- The Client ID to authenticate with Box instance.
- The Client Secret to authenticate with Box instance.
Refresh Token(required if Box Account is Box Free)
- The Refresh Token to generate Access Token. NOTE: If the process terminates, you’ll need to generate a new refresh token.
Enterprise ID(required if Box Account is Box Enterprise)
- The Enterprise ID to authenticate with Box instance.
Deployment using Dockeredit
You can deploy the Box connector as a self-managed connector client using Docker. Follow these instructions.
Step 1: Download sample configuration file
Download the sample configuration file. You can either download it manually or run the following command:
curl https://raw.githubusercontent.com/elastic/connectors/main/config.yml --output ~/connectors-config/config.yml
Remember to update the
--output argument value if your directory name is different, or you want to use a different config file name.
Step 2: Update the configuration file for your self-managed connector
Update the configuration file with the following settings to match your environment:
If you’re running the connector service against a Dockerized version of Elasticsearch and Kibana, your config file will look like this:
# When connecting to your cloud deployment you should edit the host value elasticsearch.host: http://host.docker.internal:9200 elasticsearch.api_key: <ELASTICSEARCH_API_KEY> connectors: - connector_id: <CONNECTOR_ID_FROM_KIBANA> service_type: box api_key: <CONNECTOR_API_KEY_FROM_KIBANA>
elasticsearch.api_key is the recommended authentication method. However, you can also use
elasticsearch.password to authenticate with your Elasticsearch instance.
Note: You can change other default configurations by simply uncommenting specific settings in the configuration file and modifying their values.
Step 3: Run the Docker image
Run the Docker image with the Connector Service using the following command:
docker run \ -v ~/connectors-config:/config \ --network "elastic" \ --tty \ --rm \ docker.elastic.co/enterprise-search/elastic-connectors:220.127.116.11 \ /app/bin/elastic-ingest \ -c /config/config.yml
DOCKER.md in the
elastic/connectors repo for more details.
Find all available Docker images in the official registry.
Refer to Content extraction.
Documents and syncsedit
The connector syncs the following objects and entities:
- Files bigger than 10 MB won’t be extracted.
- Permissions are not synced. All documents indexed to an Elastic deployment will be visible to all users with access to that Elastic Deployment.
Basic sync rules are identical for all connectors and are available by default.
Advanced Sync Rulesedit
Advanced sync rules are not available for this connector in the present version.
The connector framework enables operators to run functional tests against a real data source. Refer to Connector testing for more details.
To perform E2E testing for the Box connector, run the following command:
$ make ftest NAME=box
For faster tests, add the
make ftest NAME=box DATA_SIZE=small
There are no known issues for this connector. Refer to Known issues for a list of known issues for all connectors.
Framework and sourceedit
This connector is included in the Elastic connector framework.
View the source code for this connector (branch 8.11, compatible with Elastic 8.11).