Skip to content

Commit dd8bb21

Browse files
shubhamvekariya-crestapiazza-dddrichards-87
authored
[SAASINT-4023] DDS: Box: Crawler Integration v1.0.0 (#20333)
* Add Box crawler integration without assets * Add Box integration with assets * Resolve CI failure * Resolve CI Failure * Added dashboard screenshots * Update dashboards and Readme * Apply suggestions from code review Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com> --------- Co-authored-by: apiazza-dd <120594144+apiazza-dd@users.noreply.github.com> Co-authored-by: DeForest Richards <56796055+drichards-87@users.noreply.github.com>
1 parent c9bfd4c commit dd8bb21

13 files changed

+7436
-22
lines changed

box/README.md

Lines changed: 44 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,66 @@
1-
# Agent Check: box
2-
31
## Overview
42

5-
This check monitors [box][1].
3+
[Box][1] is a cloud-based file storage and collaboration platform that allows users to securely share, manage, and access files from anywhere.
4+
5+
This integration ingests **Enterprise Events** detailed logs, which includes user actions, admin activities, and Shield events from a Box enterprise instance.
6+
7+
**Note**: [Box Shield][6] must be enabled on your Box Enterprise account to access security insights and threat detection data.
8+
9+
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.
610

711
## Setup
812

9-
### Installation
13+
### Prerequisites
14+
15+
- This integration requires a Box Business or higher plan.
1016

11-
The box check is included in the [Datadog Agent][2] package.
12-
No additional installation is needed on your server.
17+
### Generate API Credentials in Box
1318

14-
### Configuration
19+
1. Log in to Box and go to the [Developer Console][3].
20+
2. Select **Create Platform App**, choose **Custom App**, enter the required app info, and then click **Next**.
21+
3. Select **Server Authentication (with Client Credentials Grant)** as the authentication method, and then click **Create App**.
22+
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**.
23+
4. In the **Authorization** tab, click **Review and Submit**, enter a brief app description, and then click **Submit**.
24+
5. Get the **Enterprise ID** from the **General** tab, and the **Client ID** and **Client Secret** from the **Configuration** tab.
25+
6. Navigate to the [Platform Apps Manager][4] in the Admin Console.
26+
7. Locate your app under **Server Authentication Apps**, click **`...` (More)**, and select **Authorize App**. When prompted, click **Authorize** to confirm.
1527

16-
!!! Add list of steps to set up this integration !!!
28+
### Connect your Box Account to Datadog
1729

18-
### Validation
30+
1. Add your Enterprise ID, Client ID and Client Secret.
31+
| Parameters | Description |
32+
| ------------- | ----------------------------------------------------------- |
33+
| Enterprise ID | The Enterprise ID of your organization in the Box platform. |
34+
| Client ID | The Client ID of your organization in the Box platform. |
35+
| Client Secret | The Client Secret of your organization in the Box platform. |
1936

20-
!!! Add steps to validate integration is functioning as expected !!!
37+
2. Click the Save button to save your settings.
38+
39+
**Note**: Monthly API call limits are listed on the [Box Pricing Page][7]. To purchase additional capacity, contact [Box Support][8].
2140

2241
## Data Collected
2342

24-
### Metrics
43+
### Logs
2544

26-
box does not include any metrics.
45+
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].
2746

28-
### Service Checks
47+
### Metrics
2948

30-
box does not include any service checks.
49+
The Box integration does not include any metrics.
3150

3251
### Events
3352

34-
box does not include any events.
35-
36-
## Troubleshooting
53+
The Box integration does not include any events.
3754

38-
Need help? Contact [Datadog support][3].
55+
## Support
3956

40-
[1]: **LINK_TO_INTEGRATION_SITE**
41-
[2]: https://app.datadoghq.com/account/settings/agent/latest
42-
[3]: https://docs.datadoghq.com/help/
57+
For any further assistance, contact [Datadog support][2].
4358

59+
[1]: https://www.box.com/
60+
[2]: https://docs.datadoghq.com/help/
61+
[3]: https://app.box.com/developers/console
62+
[4]: https://app.box.com/master/platform-apps
63+
[5]: https://developer.box.com/guides/events/enterprise-events/for-enterprise/#event-types
64+
[6]: https://www.box.com/shield
65+
[7]: https://www.box.com/pricing#:~:text=100-,API%20calls%20per%20month,-50%2C000*
66+
[8]: https://support.box.com/

box/assets/box.svg

Lines changed: 12 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)