Box connector

Back to the list of Connectors

Use the Box connector to index documents stored in your Box enterprise and make them searchable through Artemis. The connector authenticates via OAuth 2.0, allowing the platform to crawl files accessible to the authorized Box account while respecting Box access controls.

Specification	Details
Repository type	Cloud
Supported content	Documents and files (PDF, Office documents, text files, HTML, XML, JSON, CSV, Markdown)
Content filtering	Yes
Permission-aware ACL	Yes (uses Box file and folder permissions)

Prerequisites

Before configuring the connector:

• A Box enterprise account with permission to create OAuth applications.
• A Box OAuth application configured for Artemis.
• An OAuth profile created in Artemis using the Box application’s credentials. This profile is used to authenticate the connector.

Creating a Box OAuth application

For instructions on creating a Box OAuth application, see the Box Developer documentation: Create a Box OAuth 2.0 application.

Configure the following application scopes:

• root_readonly
• root_readwrite

Use the callback URL displayed when creating the OAuth profile in Artemis as the OAuth 2.0 Redirect URI for your Box application.

Configure content for ingestion

After selecting the Box OAuth profile, configure the content that Artemis should crawl and index.

The connector can index only the content that the authenticated Box account is authorized to access.

Scope

Choose the content that should be indexed.

Field	Description
Folder scope	Select All files to crawl all content accessible to the authenticated account, or Selected folders to limit indexing to specific folders.
Include subfolders	Includes nested folders under the selected scope.
Modified after	Index only files modified after the selected date. Useful for limiting the initial crawl or performing incremental indexing.
File types	Select the file types to include in the crawl, or choose All supported files to index every supported file type.
Enforce Box permissions	Preserves Box document permissions (ACLs) so only authorized users can search and access indexed content. The Box connector in Artemis automatically mirrors Box’s own access controls: it grants visibility to the file owner and to every user or group listed as a collaborator on that file (fetched directly from Box’s collaborations API), expanding groups to include their individual members. Permissions are refreshed as files sync and group memberships are re-checked every 24 hours. If Box’s collaboration data can’t be fetched, the file is withheld from search.

Generate proposal

Before activation, the platform validates the configuration and prepares the connector.

Action	Description
Generate proposal	Validates the connection and generates the proposed crawl configuration.
Dry run	Performs a validation without activating the connector, allowing you to verify the configuration.
Proposal preview	Displays the package summary, permission configuration, and validation results before activation.
Activate	Activates the connector and starts the initial crawl after successful validation.

Crawl behavior

The Box connector:

• Discovers files within the configured scope.
• Optionally crawls nested folders.
• Extracts supported document types for indexing.
• Synchronizes Box access permissions (ACLs) when Enforce Box permissions is enabled.
• Indexes only documents accessible to the authenticated Box account.