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.
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:
- Pending. Once the Source is submitted, it is validated, stored, and placed in a Pending state.
- Started. A collection task is created on the Hosted Collector.
- Initialized. The task configuration is complete in Sumo Logic.
- Authenticated. The Source successfully authenticated with Microsoft.
- 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.
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:
Log into the Azure Active Directory Portal
Select Azure Active Directory in the left menu.
Select App Registrations.
Select New Registration. Go through the registration process, providing a name for the application. Selecting Accounts in this organizational directory only is sufficient.
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.
Within the application configuration page, select Certificates and Secrets and create an Application Client Secret Key.
Copy the Client Secret value, you'll need it when creating the Source in Sumo Logic.
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 SecurityAlert.Read.All, SecurityAlert.ReadWrite.All, SecurityIncident.Read.All, SecurityIncident.ReadWrite.All and SecurityEvents.Read.All permissions. See this list to view all available security permissions.note
An Administrator must approve (grant) these permissions before the Source will function.
Follow the steps below to enable the Application permission role.
In the Manage menu, select App roles.
Click the Create app role tab.
- Display name. Enter the display name for the role.
- Allowed member types. Select Applications as the allowed member type.
- Value. Enter
SecurityAlert.Read.Allas the value.
- Description. Enter a brief description.
- Select the checkbox to enable the app role.
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:
In Sumo Logic, select Manage Data > Collection > Collection.
On the Collectors page, click Add Source next to a Hosted Collector.
Select Microsoft Graph Security API.
Enter a Name for the Source. 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
Forward to SIEM. Check the checkbox to forward your data to Cloud SIEM Enterprise. When configured with the Forward to SIEM option the following metadata fields are set:
Field Name Value _siemForward true _siemVendor Microsoft _siemProduct Graph Security API _siemFormat JSON _siemEventID This field is dynamically set based on the value of the category key in the log.
(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.
Enter the Directory (tenant) ID, Application (client) ID, and Application Client Secret Value you got from the Application you created in the prerequisite step.
The Polling Interval is set to 5 minutes by default. You can adjust it based on your needs.
Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
When you are finished configuring the Source, click Submit.
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.
|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.
To restart your source in the Sumo Logic platform, follow the steps below:
- Open the Collection page, and go to Manage Data > Collection > Collection.
- Select the source and click the information icon on the right side of the row.
- The API usage information popup is displayed. Click the Restart Source button on the bottom left.
- Click Confirm to send the restart request.
- The bottom left of the platform will provide a notification informing you the request was successful.
To restart your source using the Sumo Management API, follow the instructions below:
- Example endpoint:
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.
Internally, the source will use the following base URL depending on the respective cloud region:
|Azure Global Service||https://graph.microsoft.com|
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.
|config||JSON Object||Yes||Contains the configuration parameters for the Source.|
|schemaRef||JSON Object||Yes||Use ||not modifiable|
|sourceType||String||Yes||Use ||not modifiable|
The following table shows the config parameters for a Microsoft Graph Security API Source.
|String||Yes||Type a desired name of the Source. The name must be unique per Collector. This value is assigned to the metadata field ||modifiable|
|String||No||null||Type a description of the Source.||modifiable|
|String||No||null||Type a category of the source. This value is assigned to the metadata field ||modifiable|
|JSON Object||No||JSON map of key-value fields (metadata) to apply to the Collector or Source. Use the boolean field ||modifiable|
|String||Yes||The Directory (tenant) ID of the Azure AD application.||modifiable|
|Boolean||Yes||The Application Client Secret Key created with access to the Azure AD application.||modifiable|
|String||Yes||The Application (client) ID of the Azure AD application. modifiable|
|Boolean||No||false||Set to true if Azure tenant uses Azure Government region.||modifiable|
|Integer||Yes||5||This sets how many minutes the Source checks for new data.||modifiable|
Microsoft Graph Security API Source JSON example:
"type":"Microsoft Graph Security API"