Netskope Source

The Netskope Source provides a secure endpoint to receive event data from the Netskope API. It securely stores the required authentication, scheduling, and state tracking information.

The following event types are available to collect:

• alert events from /alerts are always collected
• application
• audit
• infrastructure
• network
• page
• connection
• incident
• endpoint

Data collected

Polling Interval	Data
5 sec	Event data

Setup

Vendor configuration

Netskope REST API v2

(This API is used by Sumo Logic Netskope source v2.0.0 and later). Netskope REST APIv2 provides an easy way to extend the Netskope platform to build to use-cases specific to your organization. Endpoints cover key areas such as Events, Alerts, Reports, Clients and more.

To obtain a Netskope REST API v2 auth token, do the following:

1. Log in to Netskope as the Tenant Admin.
2. Go to the API portion of the Netskope, Settings > Tools > Rest API v2.
3. Click "New Token", provide the token name and expiration duration, then add the following endpoints with READ privilege, depending on the events that you want to collect from: /api/v2/events/dataexport/events/alert, /api/v2/events/dataexport/events/page, /api/v2/events/dataexport/events/infrastructure, /api/v2/events/dataexport/events/application, /api/v2/events/dataexport/events/network, /api/v2/events/dataexport/events/audit, /api/v2/events/dataexport/events/connection, /api/v2/events/dataexport/events/incident, /api/v2/events/dataexport/events/endpoint, and /api/v2/events/data/alert.
4. Copy the token in the next dialog box and save it somewhere as it won't be visible after.

Netskope REST API v1 (Deprecated)

Deprecated

This is used only for Sumo Logic Netskope source v1.3.1 or lower, please upgrade to v2.0.0.

Netskope RESTv1 APIs use an auth token to make authorized calls to the API. This section demonstrates how to obtain a token from the Netskope user interface (UI).

To obtain a Netskope auth token, do the following:

1. Login to Netskope as the Tenant Admin.
2. Go to the API portion of the Netskope, Settings > Tools > Rest API v1.
3. Copy the existing token to your clipboard, or you can generate a new token and copy that token.

Source configuration

When you create a Netskope 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 Configure a Hosted Collector.

To configure a Netskope 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 Netskope.
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 Field link to 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 in the Fields table schema.
   •  An orange triangle with an exclamation point is shown when the field doesn't exist in the Fields table schema. In this case, an option to automatically add 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 it is ignored, known as dropped. 
8. Enter your Netskope customer specific Tenant ID. Do not provide the entire URL, just the Tenant ID.
9. Enter the Netskope API Token you want to use to authenticate requests.
10. Event Types (Optional). By default, all event types are collected. You can specify certain event types to collect. Make sure to have the corresponding token privileges to the event types. If this field is empty, all event types are collected. Be aware that if you want to collect all event types, and a new event type is added in the future, your token might need to be updated accordingly.
    note

    Add only the Event Types that you provided permissions to in step 3 of the Vendor configuration. For example, if you have added permission to /api/v2/events/dataexport/events/application during Netskope configuration, enter Application in the Event Types section. Inconsistencies will throw an error, so ensure that all specified permissions given in the Netskope configuration are added to the Sumo Logic Event Types section.

11. When you are finished configuring the Source, click Submit.

Metadata fields

Field	Value	Description
_siemVendor	Netskope	Set when Forward To SIEM is checked.
_siemProduct	Security Cloud	Set when Forward To SIEM is checked.
_siemFormat	JSON	Set when Forward To SIEM is checked.
_siemEventID	<eventType>	Where eventType is one of the above event types with one exception. If the eventType is audit and the description contains logon/login or logoff/logout the eventType field will be the eventType with the value -logon or -logoff added respectively, such as: audit-logon or audit-logoff.

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":"Netskope"}	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"}
tenantID	String	Yes	null	Netskope customer specific Tenant ID. Do not provide the entire URL, just the Tenant ID.
apiToken	String	Yes	null	The Netskope API Token you want to use to authenticate requests.
eventTypes	Array of Strings	No	all	Defines the types of events to collect. Accepted values are page, application, infrastructure, audit, network, connection, incident, endpoint. Alerts are always collected.

JSON example

{
    "api.version":"v1",
    "source":{
      "config":{
        "name":"YL-Netskope",
        "eventTypes":["page","application","infrastructure","audit"],
        "fields":{
          "_siemForward":false
        },
        "apiToken":"********",
        "tenantID":"partners"
      },
      "schemaRef":{
        "type":"Netskope"
      },
      "state":{
        "state":"Collecting"
      },
      "sourceType":"Universal"
    }
  }

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "netskope-source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Netskope"
  }
  config = jsonencode({
      "name":"YL-Netskope",
      "eventTypes":["page","application","infrastructure","audit"],
      "fields":{
        "_siemForward":false
      },
      "apiToken":"********",
      "tenantID":"partners"
  })
}
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.