Microsoft Graph Security API Source

The Microsoft Graph Security API Source provides a secure endpoint to receive alerts from the Microsoft Graph Security API endpoint. It securely stores the required authentication, scheduling, and state tracking information. One threat event is reported for each affected device.

Collected data

The Microsoft Graph Security API Source consumes alerts from the Microsoft Graph Security API Endpoint.

States

A Microsoft Graph Security API Source tracks errors, reports its health, and start-up progress. You’re informed, in real-time, if the Source is having trouble connecting, if there's an error requiring user action, or if it is healthy and collecting by utilizing Health Events.

A Microsoft Graph Security API Source goes through the following states when created:

1. Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
2. Started. A collection task is created on the Hosted Collector.
3. Initialized. The task configuration is complete in Sumo Logic.
4. Authenticated. The Source successfully authenticated with Microsoft.
5. Collecting. The Source is actively collecting data from Microsoft.

If the Source has any issues during any one of these states, it is placed in an Error state.

When you delete the Source, it is placed in a Stopping state. When it has successfully stopped, it is deleted from your Hosted Collector.

On the Collection page, the Health and Status for Sources is displayed. Use Health Events to investigate issues with collection. You can click the text in the Health column, such as Error, to open the issue in Health Events to investigate.

Hover your mouse over the status icon to view a tooltip with details on the detected issue.

Prerequisite

You need to create and register a service application within the Azure Active Directory portal. The user creating the service application does not need to be an administrator, however, an administrator will be needed to grant the application the appropriate permissions to the Graph Security API.

The following steps show you how to create a service application:

1. Log into the Azure Active Directory Portal

2. Select Azure Active Directory in the left menu.

   

3. Select App Registrations.

   

4. Select New Registration. Go through the registration process, providing a name for the application. Selecting Accounts in this organizational directory only is sufficient.

   

5. After the application is registered ensure you copy the Application (client) ID and Directory (tenant) ID displayed on the Overview page. These are needed when creating the Source in Sumo Logic.

   

6. Within the application configuration page, select Certificates and Secrets and create an Application Client Secret Key.

   

7. Copy the Client Secret value, you'll need it when creating the Source in Sumo Logic.

   

8. Request the appropriate permissions for the application. Click on API Permissions, then Add a permission and select Microsoft Graph.

   You need to find and select the SecurityEvents.Read.All permission. See this list of all the available security permissions.

   note

   An Administrator must approve (grant) these permissions before the Source will function.

   

Create a Microsoft Graph Security API Source

When you create a Microsoft Graph Security 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 Microsoft Graph Security API Source:

1. In Sumo Logic, select Manage Data > Collection > Collection. 

2. On the Collectors page, click Add Source next to a Hosted Collector.

3. Select Microsoft Graph Security API.

   

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 Enterprise. If you click the checkbox, another option appears: Use Dynamic Vendor and Product SIEM Metadata.

   • If you don't checkmark Use Dynamic Vendor and Product SIEM Metadata, the metadata fields that identify vendor and product (_siemVendor and _siemProduct) will be set to Security Graph API.* If you do checkmark Use Dynamic Vendor and Product SIEM Metadata, CSE will retain the original product information. This is helpful when multiple data sources from multiple vendors and products are proxied through the Microsoft Security Graph API and you want the original vendor and product metadata information reflected in CSE. The table below shows the metadata fields that CSE sets.
     

   Field Name	Value
   _siemForward	true
   _siemVendor	This field is dynamically set based on the value of the vendor information in the log. MS Sec Graph API {{vendorInformation.vendor}}
   _siemProduct	This field is dynamically set based on the value of the vendor information in the log. MS Sec Graph API{{vendorInformation.provider}}
   _siemFormat	JSON
   _siemEventID	This field is dynamically set based on the value of the category key in the log. {{category}}

2. (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.

3. Enter the Directory (tenant) ID, Application (client) ID, and Application Client Secret Value you got from the Application you created in the prerequisite step.

4. The Polling Interval is set to 300 seconds by default, you can adjust it based on your needs.

5. Use Dynamic Vendor and Product SIEM Metadata. Check the checkbox to dynamically set the vendor and product metadata information (_siemVendor and _siemProduct) so that CSE retains the original product information. This is helpful when multiple data sources from multiple vendors and products are proxied through the Microsoft Security Graph API and you want the original vendor and product metadata information reflected in CSE.

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

Error types

When Sumo Logic detects an issue it is tracked by Health Events. The following table shows the three possible error types, the reason the error would occur, if the Source attempts to retry, and the name of the event log in the Health Event Index.

Type	Reason	Retries
ThirdPartyConfig	Normally due to an invalid configuration. You'll need to review your Source configuration and make an update.	No retries are attempted until the Source is updated.
ThirdPartyGeneric	Normally due to an error communicating with the third party service APIs.	Yes
FirstPartyGeneric	Normally due to an error communicating with the internal Sumo Logic APIs.	Yes

Restarting your Source

If your Source encounters ThirdPartyConfig errors, you can restart it from either the Sumo Logic UI or Sumo Logic API.

UI

To restart your source in the Sumo Logic platform, follow the steps below:

1. Open the Collection page, and go to Manage Data > Collection > Collection.
2. Select the source and click the information icon on the right side of the row.
3. The API usage information popup is displayed. Click the Restart Source button on the bottom left.
   
4. Click Confirm to send the restart request.
   
5. The bottom left of the platform will provide a notification informing you the request was successful.
   

API

To restart your source using the Sumo Management API, follow the instructions below:

• Method: POST
• Example endpoint:

  https://api.sumologic.com/api/v1/collectors/{collector_id}/sources/{source_id}/action/restart

Sumo Logic endpoints like api.sumologic.com are different in deployments outside us1. For example, an API endpoint in Europe would begin api.eu.sumologic.com. A service endpoint in us2 (Western U.S.) would begin service.us2.sumologic.com. For more information, see Sumo Logic Endpoints.

JSON configuration

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	Required	Description	Access
config	JSON Object	Yes	Contains the configuration parameters for the Source.
schemaRef	JSON Object	Yes	Use {"type":"Microsoft Graph Security API"} for a Microsoft Graph Security API Source.	not modifiable
sourceType	String	Yes	Use Universal for a Microsoft Graph Security API Source.	not modifiable

The following table shows the config parameters for a Microsoft Graph Security API Source.

Parameter	Type	Required?	Default	Description	Access
name	String	Yes		Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field _source.	modifiable
description	String	No	null	Type a description of the Source.	modifiable
category	String	No	null	Type a category of the source. This value is assigned to the metadata field _sourceCategory. See best practices for details.	modifiable
fields	JSON Object	No		JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field _siemForward to enable forwarding to SIEM.	modifiable
set_metadata_fields	Boolean	No	false	Set to true to assign metadata fields for Cloud SIEM Enterprise.	modifiable
tenant_id	String	Yes		The Directory (tenant) ID of the Azure AD application.	modifiable
secret_key	Boolean	Yes		The Application Client Secret Key created with access to the Azure AD application.	modifiable
application_id	String	Yes		The Application (client) ID of the Azure AD application. modifiable
polling_interval	Integer	Yes	300	This sets how many seconds the Source checks for new data.	modifiable

Microsoft Graph Security API Source JSON example:

{
  "api.version":"v1",
  "source":{
    "schemaRef":{
      "type":"Microsoft Graph Security API"
    },
    "state":{
      "state":"Authenticated"
    },
    "config":{
      "name":"Graph Security",
      "tenant_id":"********",
      "set_metadata_fields":true,
      "polling_interval":300,
      "secret_key":"********",
      "fields":{
        "_siemForward":false
      },
      "category":"graph-api",
      "application_id":"********"
    },
    "sourceType":"Universal"
  }
}