Box Source

The Box API integration ingests events from the Get Events API. It securely stores the required authentication, scheduling, and state tracking information.

Data collected

Polling Interval	Data
5 min	Events

Setup

Vendor configuration

1. Login into the Box Account.
2. Create and register a new app from the App Console. To register the App with Box follow these steps. Select Server Authentication (with JWT) as the authentication method. Note that use of a key pair requires 2-step verification to be enabled on Box.
3. Generate public private key pair as described in the following steps Key Pair and download the JSON file.
4. Go to the Configuration and change App Access Level to App + Enterprise Access and enable Manage Enterprise properties in Application Scopes and save changes as shown below.
   
   
   
5. Authorize your app by following the steps in App Authorization.

Source configuration

When you create a Box Source, you add it to a Hosted Collector. Before creating the Source, identify the Hosted Collector you want to use or create a new Hosted Collector. For instructions, see Create a Hosted Collector.

To configure a Box Source:

1. Classic UI. In the main Sumo Logic menu, select Manage Data > Collection > Collection.
   New UI. In the Sumo Logic top menu select Configuration, and then under Data Collection select Collection. You can also click the Go To... menu at the top of the screen and select Collection.
2. On the Collectors page, click Add Source next to a Hosted Collector.
3. Search for and select Box.
4. Enter a Name for the Source. The description is optional.
5. (Optional) For Source Category, enter any string to tag the output collected from the Source. Category metadata is stored in a searchable field called _sourceCategory.
6. Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM.
   
   note

   Select Forward to SIEM only if you have Cloud SIEM installed.

7. (Optional) Fields. Click the +Add link to add custom log metadata Fields.
   • Define the fields you want to associate, each field needs a name (key) and value.
     • A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
     • An orange triangle with an exclamation point is shown when the field doesn't exist, or is disabled, in the Fields table schema. In this case, an option to automatically add or enable the nonexistent fields to the Fields table schema is provided. If a field is sent to Sumo that does not exist in the Fields schema or is disabled it is ignored, known as dropped.
8. Upload the JSON file.
9. Processing Rules. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
10. When you are finished configuring the Source, click Submit.

Metadata fields

Field	Value	Description
_siemVendor	Box	Set when Forward To SIEM is checked.
_siemProduct	Enterprise Events	Set when Forward To SIEM is checked.
_siemFormat	JSON	Set when Forward To SIEM is checked.
_siemEventID	event_type	Set when Forward To SIEM is checked.

JSON schema

Sources can be configured using UTF-8 encoded JSON files with the Collector Management API. See how to use JSON to configure Sources for details.

Parameter	Type	Value	Required	Description
schemaRef	JSON Object	{"type":"Box"}	Yes	Define the specific schema type.
sourceType	String	"Universal"	Yes	Type of source.
config	JSON Object	Configuration object	Yes	Source type specific values.

Configuration Object

Parameter	Type	Required	Default	Description	Example
name	String	Yes	null	Type a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source.	"mySource"
description	String	No	null	Type a description of the source.	"Testing source"
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	"mySource/test"
fields	JSON Object	No	null	JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	{"_siemForward": false, "fieldA": "valueA"}
credentialsJson	String	Yes	null	JAuthentication credentials to access Box platform.

JSON example

{
    "api.version":"v1",
    "source":{
      "schemaRef":{
        "type":"Box"
      },
      "config":{
        "name":"box-test-1",
        "fields":{
          "_siemForward":false
        },
        "credentialsJson":"********"
      },
      "state":{
        "state":"Collecting"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "box_source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Box"
  }
  config = jsonencode({
      "name":"box-test-1",
      "fields":{
        "_siemForward":false
      },
      "credentialsJson":"********"
  })
}
resource "sumologic_collector" "collector" {
  name        = "my-collector"
  description = "Just testing this"
}

Download example

FAQ

info

Click here for more information about Cloud-to-Cloud sources.