[SAASINT-4023] DDS: Box: Crawler Integration v1.0.0

box/README.md

@@ -1,43 +1,66 @@
-# Agent Check: box
-
 ## Overview
 
-This check monitors [box][1].
+[Box][1] is a cloud-based file storage and collaboration platform that allows users to securely share, manage, and access files from anywhere.
+
+This integration ingests **Enterprise Events** detailed logs, which includes user actions, admin activities, and Shield events from a Box enterprise instance.
+
+**Note**: [Box Shield][6] must be enabled on your Box Enterprise account to access security insights and threat detection data.
+
+This integration gathers enterprise events and forwards them to Datadog for seamless analysis. Datadog leverages its built-in log pipelines to parse and enrich these logs, facilitating easy search and detailed insights. With preconfigured dashboards, the integration offers clear visibility into activities within the Box platform. Additionally, it includes ready-to-use Cloud SIEM detection rules for enhanced monitoring and security.
 
 ## Setup
 
-### Installation
+### Prerequisites
+
+- This integration requires a Box Business or higher plan.
 
-The box check is included in the [Datadog Agent][2] package.
-No additional installation is needed on your server.
+### Generate API Credentials in Box
 
-### Configuration
+1. Log in to Box and go to the [Developer Console][3]. 
+2. Select **Create Platform App**, choose **Custom App**, enter the required app info, and then click **Next**.
+3. Select **Server Authentication (with Client Credentials Grant)** as the authentication method, and then click **Create App**.
+3. Go to the **Configuration** tab, select **App + Enterprise Access** under **App Access Level**, check **Generate user access tokens** under **Advanced Features**, and then click **Save Changes**.
+4. In the **Authorization** tab, click **Review and Submit**, enter a brief app description, and then click **Submit**.
+5. Get the **Enterprise ID** from the **General** tab, and the **Client ID** and **Client Secret** from the **Configuration** tab.
+6. Navigate to the [Platform Apps Manager][4] in the Admin Console. 
+7. Locate your app under **Server Authentication Apps**, click **`...` (More)**, and select **Authorize App**. When prompted, click **Authorize** to confirm.
 
-!!! Add list of steps to set up this integration !!!
+### Connect your Box Account to Datadog
 
-### Validation
+1. Add your Enterprise ID, Client ID and Client Secret.
+   | Parameters    | Description                                                 |
+   | ------------- | ----------------------------------------------------------- |
+   | Enterprise ID | The Enterprise ID of your organization in the Box platform. |
+   | Client ID     | The Client ID of your organization in the Box platform.     |
+   | Client Secret | The Client Secret of your organization in the Box platform. |
 
-!!! Add steps to validate integration is functioning as expected !!!
+2. Click the Save button to save your settings.
+
+**Note**: Monthly API call limits are listed on the [Box Pricing Page][7]. To purchase additional capacity, contact [Box Support][8].
 
 ## Data Collected
 
-### Metrics
+### Logs
 
-box does not include any metrics.
+The Box integration collects and forwards enterprise events to Datadog. For more information about the logs collected by this integration, see the Box Enterprise Events API [Docs][5].
 
-### Service Checks
+### Metrics
 
-box does not include any service checks.
+The Box integration does not include any metrics.
 
 ### Events
 
-box does not include any events.
-
-## Troubleshooting
+The Box integration does not include any events.
 
-Need help? Contact [Datadog support][3].
+## Support
 
-[1]: **LINK_TO_INTEGRATION_SITE**
-[2]: https://app.datadoghq.com/account/settings/agent/latest
-[3]: https://docs.datadoghq.com/help/
+For any further assistance, contact [Datadog support][2].
 
+[1]: https://www.box.com/
+[2]: https://docs.datadoghq.com/help/
+[3]: https://app.box.com/developers/console
+[4]: https://app.box.com/master/platform-apps
+[5]: https://developer.box.com/guides/events/enterprise-events/for-enterprise/#event-types
+[6]: https://www.box.com/shield
+[7]: https://www.box.com/pricing#:~:text=100-,API%20calls%20per%20month,-50%2C000*
+[8]: https://support.box.com/