Skip to main content

Box Source

box-logo.svg

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

note

This source is available in the Fed deployment.

Data collected

Polling IntervalData
5 minEvents

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.
    Box
    Box
    Box
  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. In Sumo Logic, navigate to Manage Data > Collection and open the Collection tab.
  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.
  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.
      • green check circle.png A green circle with a check mark is shown when the field exists and is enabled in the Fields table schema.
      • orange exclamation point.png 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

FieldValueDescription
_siemVendorBoxSet when Forward To SIEM is checked.
_siemProductEnterprise EventsSet when Forward To SIEM is checked.
_siemFormatJSONSet when Forward To SIEM is checked.
_siemEventIDevent_typeSet 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.

ParameterTypeValueRequiredDescription
schemaRefJSON Object{"type":"Box"}YesDefine the specific schema type.
sourceTypeString"Universal"YesType of source.
configJSON ObjectConfiguration objectYesSource type specific values.

Configuration Object

ParameterTypeRequiredDefaultDescriptionExample
nameStringYesnullType a desired name of the source. The name must be unique per Collector. This value is assigned to the metadata field _source."mySource"
descriptionStringNonullType a description of the source."Testing source"
categoryStringNonullType a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details."mySource/test"
fieldsJSON ObjectNonullJSON 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"}
credentialsJsonStringYesnullJAuthentication 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.

Legal
Privacy Statement
Terms of Use

Copyright © 2024 by Sumo Logic, Inc.