Docy

Configure Netskope Tenants

Configure Netskope Tenants

To leverage the primary modules to work with Netskope, you need to create a Netskope tenant in CE. Configured Netskope tenants are displayed on the Netskope Tenants page, and Admins can edit and delete configured tenants.

You need your Netskope tenant API token(s) to complete this procedure.

Obtain your v1 RESTful API token by following the steps in REST API v1 Overview CE uses v1 tokens for updating file hashes in Threat Exchange.

Important

A v1 token is required for adding a Netskope tenant in CE, but will not be used if an equivalent v2 endpoint is available.

Create a new v2 RESTful API token by following the steps in REST API v2 Overview. For v2 tokens, specific scopes need to be enabled. For more information, see REST API Scopes.

When you have your token(s), copy them and then add a tenant to CE.

Click play to watch a demo:

 

Add a Netskope Tenant

  1. Go to Settings and click Netskope Tenants. A list of configured Netskope tenants are displayed. There are Edit and Delete icons for each tenant in the Action column.
    image55.png
  2. Click Add Tenant.
  3. Enter parameters for these fields:
    FieldDescription
    NameNetskope tenant configuration name.
    Tenant NameNetskope tenant name.
    V1 API TokenAPI token to authenticate the tenant.
    V2 API TokenAPI token to authenticate the tenant.
    Alerts FilterFilters the incoming alerts.
    Initial RangeNumber of days to pull the data for initial run.
    System ProxyThe system proxy configured in the Netskope tenant Settings.
    CE-Log-Shipper-Tenant.png
  4. When finished, click Save.

REST API Scopes

4.2.0 REST API

Dataexport Error Codes

Error CodesUser-Action RequiredDescription
403YesCheck the API V2 token is associated with the valid endpoint & its not expired.Retry will solve the problem only after solving the token issue by following these guidelines
409NoConcurrency conflict and the request cannot be processed at this point of time.

DataExport API V2 endpoints do not support downloading the same event type concurrently with the same iterator index, and the Client is expected to validate that the logic to pull the events is single-threaded.

429NoToo many requests for the same tenant accessing the same endpoint.

The Client is expected to honor the rate limit to avoid 429 error and as part of the response header, it carries the reset time in the header ratelimit-reset. The Client is expected to sleep/wait ( ratelimit-reset ) to avoid 429.

The current rate limit is 4 req / second/endpoint.

5XXYesNetskope is having a temporary server issue for some reason:
  • DataBase Query timeout
  • Server overloaded
  • Internal DNS issues

Upon receiving a 5xx error from Netskope Server , the User is recommended to do a back off of 5 seconds wait time before the next call.

v1 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
Token Generated and Not Expired(all)xRequired for sharing file hashes
v2 REST API Scopes

Note

Starting with CE 4.2.0, you are required to use the dataexport endpoint permission for the alerts and events you have configured in Cloud Exchange when setting up Netskope Tenants.

EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
/api/v2/events/data/alertRead
/api/v2/events/data/applicationRead
/api/v2/events/data/auditRead
/api/v2/events/data/infrastructureRead
/api/v2/events/data/networkRead
/api/v2/events/data/pageRead
/api/v2/events/dataexport/events/alertReadxxxxxRequired to validate API token
/api/v2/events/dataexport/events/applicationReadxx
/api/v2/events/dataexport/events/auditReadx
/api/v2/events/dataexport/events/connectionRead
/api/v2/events/dataexport/events/incidentReadx
/api/v2/events/dataexport/events/infrastructureReadx
/api/v2/events/dataexport/events/networkReadx
/api/v2/events/dataexport/events/pageReadx
/api/v2/events/dataexport/alerts/ubaReadxx
/api/v2/events/dataexport/alerts/securityassessmentReadxx
/api/v2/events/dataexport/alerts/quarantineReadxxx
/api/v2/events/dataexport/alerts/remediationReadxx
/api/v2/events/dataexport/alerts/policyReadxx
/api/v2/events/dataexport/alerts/malwareReadxxx
/api/v2/events/dataexport/alerts/malsiteReadxxx
/api/v2/events/dataexport/alerts/compromisedcredentialReadxx
/api/v2/events/dataexport/alerts/ctep (or ips)Readxx
/api/v2/events/dataexport/alerts/dlpReadxx
/api/v2/events/dataexport/alerts/watchlistReadxx
/api/v2/policy/urllist/fileRead + Write
/api/v2/policy/urllistRead + Writex
/api/v2/policy/urllist/deployRead + Writex
/api/v2/incidents/uba/getuciRead + Writex
/api/v2/ubadatasvc/user/uciRead + Writex
/api/v2/services/cci/appReadx
/api/v2/services/cci/domainReadx
/api/v2/services/cci/tagsReadx

x: Required API scopes for the corresponding CE module.

4.1.0 REST API

v1 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
Token Generated and Not Expired(all)xRequired for sharing file hashes
v2 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
/api/v2/events/data/alertRead
/api/v2/events/data/applicationRead
/api/v2/events/data/auditRead
/api/v2/events/data/infrastructureRead
/api/v2/events/data/networkRead
/api/v2/events/data/pageRead
/api/v2/events/dataexport/events/alertReadxxxxxRequired to validate API token
/api/v2/events/dataexport/events/applicationReadxx
/api/v2/events/dataexport/events/auditReadx
/api/v2/events/dataexport/events/connectionRead
/api/v2/events/dataexport/events/incidentReadx
/api/v2/events/dataexport/events/infrastructureReadx
/api/v2/events/dataexport/events/networkReadx
/api/v2/events/dataexport/events/pageReadx
/api/v2/events/dataexport/alerts/ubaReadxx
/api/v2/events/dataexport/alerts/securityassessmentReadxx
/api/v2/events/dataexport/alerts/quarantineReadxxx
/api/v2/events/dataexport/alerts/remediationReadxx
/api/v2/events/dataexport/alerts/policyReadxx
/api/v2/events/dataexport/alerts/malwareReadxxx
/api/v2/events/dataexport/alerts/malsiteReadxxx
/api/v2/events/dataexport/alerts/compromisedcredentialReadxx
/api/v2/events/dataexport/alerts/ctep (or ips)Read
/api/v2/events/dataexport/alerts/dlpReadxx
/api/v2/events/dataexport/alerts/watchlistReadxx
/api/v2/policy/urllist/fileRead + Write
/api/v2/policy/urllistRead + Writex
/api/v2/policy/urllist/deployRead + Writex
/api/v2/incidents/uba/getuciRead + Writex
/api/v2/ubadatasvc/user/uciRead + Writex
/api/v2/services/cci/appReadx
/api/v2/services/cci/domainReadx
/api/v2/services/cci/tagsReadx

x: Required API scopes for the corresponding CE module.

4.0.x REST API

v1 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
Token Generated and Not Expired(all)yyx+y (*)yy* Required for sharing file hashes
v2 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
/api/v2/events/data/alertReadyyyyy
/api/v2/events/data/applicationReady
/api/v2/events/data/auditReady
/api/v2/events/data/infrastructureReady
/api/v2/events/data/networkReady
/api/v2/events/data/pageReady
/api/v2/events/dataexport/events/alertReadxxxxx
/api/v2/events/dataexport/events/applicationReadxx
/api/v2/events/dataexport/events/auditReadx
/api/v2/events/dataexport/events/connectionRead
/api/v2/events/dataexport/events/incidentRead
/api/v2/events/dataexport/events/infrastructureReadx
/api/v2/events/dataexport/events/networkReadx
/api/v2/events/dataexport/events/pageReadx
/api/v2/events/dataexport/alerts/ubaRead
/api/v2/events/dataexport/alerts/securityassessmentRead
/api/v2/events/dataexport/alerts/quarantineRead
/api/v2/events/dataexport/alerts/remediationRead
/api/v2/events/dataexport/alerts/policyRead
/api/v2/events/dataexport/alerts/malwareRead
/api/v2/events/dataexport/alerts/malsiteRead
/api/v2/events/dataexport/alerts/compromisedcredentialRead
/api/v2/events/dataexport/alerts/ctep (or ips)Read
/api/v2/events/dataexport/alerts/dlpRead
/api/v2/events/dataexport/alerts/watchlistRead
/api/v2/policy/urllist/fileRead + Write
/api/v2/policy/urllistRead + Writex + y
/api/v2/policy/urllist/deployRead + Writex + y
/api/v2/incidents/uba/getuciRead + Writex + y
/api/v2/ubadatasvc/user/uciRead + Writex + y
/api/v2/services/cci/appReadx + y
/api/v2/services/cci/domainReadx + y
/api/v2/services/cci/tagsReadx + y

x: Required API scopes for the corresponding CE module if modern /events/dataexport endpoints will be used (recommended).

y: Required API scopes for the corresponding CE module if legacy /events/data endpoints will be used (deprecated starting in 4.1.0).

x+y: Required API scopes for the corresponding CE module (when using either /events/dataexport or /events/data endpoints).

3.4.x REST API

v1 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)User Risk Exchange (URE)App Risk Exchange (ARE)Notes
Token Generated and Not Expired(all)yRequired for sharing file hashes
v2 REST API Scopes
EndpointPrivilegeLog Shipper (CLS)Ticket Orchestrator (CTO)Threat Exchange (CTE)Cloud Risk Exchange (CRE)Notes
/api/v2/events/data/alertReadyyyy
/api/v2/events/data/applicationReady
/api/v2/events/data/auditReady
/api/v2/events/data/infrastructureReady
/api/v2/events/data/networkReady
/api/v2/events/data/pageReady
/api/v2/events/dataexport/events/alertRead
/api/v2/events/dataexport/events/applicationRead
/api/v2/events/dataexport/events/auditRead
/api/v2/events/dataexport/events/connectionRead
/api/v2/events/dataexport/events/incidentRead
/api/v2/events/dataexport/events/infrastructureRead
/api/v2/events/dataexport/events/networkRead
/api/v2/events/dataexport/events/pageRead
/api/v2/events/dataexport/alerts/ubaRead
/api/v2/events/dataexport/alerts/securityassessmentRead
/api/v2/events/dataexport/alerts/quarantineRead
/api/v2/events/dataexport/alerts/remediationRead
/api/v2/events/dataexport/alerts/policyRead
/api/v2/events/dataexport/alerts/malwareRead
/api/v2/events/dataexport/alerts/malsiteRead
/api/v2/events/dataexport/alerts/compromisedcredentialRead
/api/v2/events/dataexport/alerts/ctep (or ips)Read
/api/v2/events/dataexport/alerts/dlpRead
/api/v2/events/dataexport/alerts/watchlistRead
/api/v2/policy/urllist/fileRead + Write
/api/v2/policy/urllistRead + Writey
/api/v2/policy/urllist/deployRead + Writey
/api/v2/incidents/uba/getuciRead + Writey
/api/v2/ubadatasvc/user/uciRead + Writey
/api/v2/services/cci/appRead
/api/v2/services/cci/domainRead
/api/v2/services/cci/tagsRead

y: Required API scopes for the corresponding CE module.

Share this Doc
In this topic ...