docs/reference/search-connectors/es-connectors-box.md
Th Box connector is written in Python using the Elastic connector framework.
View the source code for this connector (branch main, compatible with Elastic 9.0).
This connector is available as a self-managed connector. To use this connector, satisfy all self-managed connector prerequisites.
::::{note} 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 create a new Box connector:
You can use the {{es}} Create connector API to create a new self-managed Box self-managed connector.
For example:
PUT _connector/my-box-connector
{
"index_name": "my-elasticsearch-index",
"name": "Content synced from Box",
"service_type": "box"
}
% TEST[skip:can’t test in isolation]
:::::{dropdown} You’ll also need to create an API key for the connector to use.
::::{note}
The user needs the cluster privileges manage_api_key, manage_connector and write_connector_secrets to generate API keys programmatically.
::::
To create an API key for the connector:
Run the following command, replacing values where indicated. Note the encoded return values from the response:
POST /_security/api_key
{
"name": "connector_name-connector-api-key",
"role_descriptors": {
"connector_name-connector-role": {
"cluster": [
"monitor",
"manage_connector"
],
"indices": [
{
"names": [
"index_name",
".search-acl-filter-index_name",
".elastic-connectors*"
],
"privileges": [
"all"
],
"allow_restricted_indices": false
}
]
}
}
}
Update your config.yml file with the API key encoded value.
:::::
Refer to the {{es}} API documentation for details of all available Connector APIs.
To use this connector as a self-managed connector, use the Box tile from the connectors list OR Customized connector workflow.
For additional operations, see Connectors UI in {{kib}}.
$$$es-connectors-box-client-create-oauth-custom-app$$$ Create Box User Authentication (OAuth 2.0) Custom App
You’ll need to create an OAuth app in the Box developer console by following these steps:
$$$es-connectors-box-client-connector-generate-a-refresh-token$$$ Generate a refresh Token
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:
https://account.box.com/api/oauth2/authorize?response_type=code&client_id=<CLIENT_ID>
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 curl command, replacing <AUTHORIZATION_CODE>, <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.
$$$es-connectors-box-client-connector-create-box-server-authentication-client-credentials-grant-custom-app$$$ Create Box Server Authentication (Client Credentials Grant) Custom App
Register a new app in the Box dev console with custom App and select Server Authentication (Client Credentials Grant).
Check following permissions:
Select App + Enterprise Access in App Access Level.
Authorize your application from the admin console. If you do not have permission, you may need to submit the application for authorization. Save the Client Credentials and Enterprise ID. You’ll need these to configure the connector.
Box Account (required)
: Dropdown to determine Box Account type: Box Free Account or Box Enterprise Account. Default value is Box Free Account.
Client ID (required)
: The Client ID to authenticate with Box instance.
Client Secret (required)
: 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.
You can deploy the Box connector as a self-managed connector using Docker. Follow these instructions.
::::{dropdown} 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/app/connectors_service/config.yml.example --output ~/connectors-config/config.yml
% NOTCONSOLE
Remember to update the --output argument value if your directory name is different, or you want to use a different config file name.
::::
::::{dropdown} Step 2: Update the configuration file for your self-managed connector Update the configuration file with the following settings to match your environment:
elasticsearch.hostelasticsearch.api_keyconnectorsIf 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> # Optional. If not provided, the connector will use the elasticsearch.api_key instead
Using the elasticsearch.api_key is the recommended authentication method. However, you can also use elasticsearch.username and 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.
::::
::::{dropdown} 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/integrations/elastic-connectors:{{version.stack}} \
/app/bin/elastic-ingest \
-c /config/config.yml
::::
Refer to DOCKER.md in the elastic/connectors repo for more details.
Find all available Docker images in the official registry.
::::{tip}
We also have a quickstart self-managed option using Docker Compose, so you can spin up all required services at once: Elasticsearch, Kibana, and the connectors service. Refer to this README in the elastic/connectors repo for more information.
::::
Refer to Content extraction.
The connector syncs the following objects and entities:
::::{note}
::::
Full syncs are supported by default for all connectors.
This connector also supports incremental syncs.
Basic sync rules are identical for all connectors and are available by default.
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 DATA_SIZE=small flag:
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.
See Troubleshooting.
See Security.