SentinelOne Mgmt API Source
The SentinelOne Mgmt API Source collects data from the SentinelOne Management Console. It securely stores the required authentication, scheduling, and state tracking information.
Data collected
Polling Interval | Data |
---|---|
5 min | Activities |
5 min | Agents |
5 min | Threats |
Setup
Vendor configuration
The SentinelOne Mgmt API Source requires authentication with a token associated with ApiToken. See how to generate an API Token from SentinelOne documentation. The following steps are provided as a guide.
To generate an API token:
- Sign in to the SentinelOne Management Console with Admin user credentials.
- In the Management Console, click Settings.
- In the Settings view, click Users.
- Click Service Users.
- Click Actions dropdown and select Create New Service User.
- Enter the information for the new service user.
- In Role, select Admin.
- Click Save.
- Log in to the SentinelOne Management Console with the credentials of the new user.
- Navigate to Settings > Users.
- Select the newly added service user.
- Click Options.
- Click Generate API token.
- Copy or download this API Token.
Source configuration
When you create a SentinelOne Mgmt API 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 SentinelOne Mgmt API Source:
- 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. - On the Collectors page, click Add Source next to a Hosted Collector.
- Search for and select SentinelOne Mgmt API.
- Enter a Name to display for the Source in the Sumo web application. The description is optional.
- (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
. - 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.
- (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.
- Base URL. Provide your SentinelOne Management URL. It's in this format:
https://<your_management_url>
. - API Token. Provide the API Token you got from the SentinelOne Management Console. See Authentication above for details.
- Supported APIs to collect. Select one or more of the available APIs: activities, agents, and threats.
- When you are finished configuring the Source, click Submit.
Metadata fields
Field | Value | Description |
---|---|---|
_siemVendor | SentinelOne | Set when Forward To SIEM is checked. |
_siemProduct | MGMT API | Set when Forward To SIEM is checked. |
_siemFormat | JSON | Set when Forward To SIEM is checked. |
_siemEventID | activities - {id} , threats - {id} , or agents | Set when Forward To SIEM is checked and specific to the API collected. |
_siemDataType | Inventory | Set when Forward To SIEM is checked. |
If you entered agents
in Supported APIs to collect above, the _siemDataType
field will be set to Inventory
.
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":"SentinelOne Mgmt API"} | 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"} |
base_url | String | Yes | null | Provide your SentinelOne Management URL. It's in this format: https://<your_management_url> . | |
api_secret | String | Yes | null | Provide your API Token from SentinelOne that you want to use to authenticate collection requests. | |
supported_apis | Array of strings | Yes | null | Define one or more of the available APIs to collect: activities, agents, and threats. For example, for all three you'd use: ["activities","agents","threats"] |
JSON example
{
"api.version":"v1",
"source":{
"config":{
"name":"SentinelOne",
"supported_apis":["activities","agents","threats"],
"api_secret":"********",
"base_url":"https://usea1-partners.sentinelone.net/",
"fields":{
"_siemForward":false
}
},
"schemaRef":{
"type":"SentinelOne Mgmt API"
},
"state":{
"state":"Collecting"
},
"sourceType":"Universal"
}
}
Terraform example
resource "sumologic_cloud_to_cloud_source" "sentinelone_mgmt_api_source" {
collector_id = sumologic_collector.collector.id
schema_ref = {
type = "SentinelOne Mgmt API"
}
config = jsonencode({
"name":"SentinelOne",
"supported_apis":["activities","agents","threats"],
"api_secret":"********",
"base_url":"https://usea1-partners.sentinelone.net/",
"fields":{
"_siemForward":false
}
})
}
resource "sumologic_collector" "collector" {
name = "my-collector"
description = "Just testing this"
}
FAQ
Click here for more information about Cloud-to-Cloud sources.