Microsoft Azure AD Inventory Source

The Microsoft Azure AD Inventory Source collects user and device data from the Microsoft Graph API Security endpoint. It securely stores the required authentication, scheduling, and state tracking information.

If you want to explicitly allow the static IP addresses used for this Source on your firewall see our table of static IP addresses by deployment.

Data collected

Polling Interval	Data
12 hours	Users
12 hours	Devices

Setup

Vendor configuration

The Source requires the creation and registration of 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 is needed to grant the application the appropriate permissions to the Users and Devices APIs.

Use the following steps to create a service application:

1. Sign in to the Azure Active Directory Portal
2. Then select Azure Active Directory in the left menu.
3. Then select App Registrations.
   
4. Then 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 (created), be sure to copy the Application (client) ID and the Directory (tenant) ID. These are used later as configuration parameters in Sumo Logic when creating the Microsoft Azure AD Inventory Source.
6. Within the Application configuration page, select Certificates and Secrets to create an Application Client Secret Key.
7. Copy the Client Secret Value (pictured below). It's needed later in Sumo Logic when creating the Microsoft Azure AD Inventory Source.
8. Request the appropriate permissions for the application. Click on API Permissions, then Add a permission and select Microsoft Graph.

From there, select (or search for) the following permissions under type Application permissions. An Administrator must approve (grant) these permissions before the integration will function.

API	Account Type	Permissions
User	Application (work or school account)	User.Read.All, Directory.ReadAll
Devices	Application (work or school account)	Device.Read.All, Directory.ReadAll

You require additional permission to collect signInActivityData for User.

API	Account Type	Permissions
Directory Audit	Application (work or school account)	AuditLog.Read.All

Personal Microsoft accounts are not supported.

Source configuration

When you create a Microsoft Azure AD Inventory 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 Azure AD Inventory 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 Microsoft Azure AD Inventory.
4. Enter a Name to display for the Source in the Sumo web application. 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. Provide the Directory (tenant) ID and Application (client) ID you got after you registered (created) the Azure Application in step 5 of the setup section.
9. Application Client Secret Value. Provide the Application Client Secret Value you created in step 7 of the setup section.
10. Supported APIs to collect. Select one or more of the available APIs: Devices and Users.
11. Collect Users SignInActivity Data. By enabling the checkbox, you can also include the sign in activity information in your user response. Learn more.
    note

    To collect the signInActivity information you should have Azure AD Premium P1/P2 license.

12. Collect Users Group Details. By enabling the checkbox, you can also include the user group information in your user response. Learn more.
    note

    To know about the permissions required to collect user group details, refer to the Microsoft documentation.

13. Processing Rules for Logs. Configure any desired filters, such as allowlist, denylist, hash, or mask, as described in Create a Processing Rule.
14. When you are finished configuring the Source, click Submit.

Metadata fields

Field	Value	Description
_siemVendor	Microsoft	Set when Forward To SIEM is checked.
_siemProduct	Azure AD	Set when Forward To SIEM is checked.
_siemDataType	Inventory	Set when Forward To SIEM is checked and specific to the API collected.

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":"Microsoft Azure AD Inventory"}	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"}
tenant_id	String	Yes	null	Provide the Directory (tenant) ID you got after you registered (created) the Azure Application.
secret_key	String	Yes	null	Provide the Application Client Secret Value you created in Azure.
application_id	String	Yes	null	Provide the Application (client) ID you got after you registered (created) the Azure Application.
supported_apis	Array of strings	Yes	null	Define one or more of the available APIs to collect: Devices, and Users.	["Devices","Users"]
userSignInActivity	Boolean	No	False	Select the checkbox to include the sign in activity information in your user response.
userGroupDetails	Boolean	No	False	Select the checkbox to include the user’s group details in your user response.

JSON example

{
    "api.version": "v1",
    "source": {
        "schemaRef": {
            "type": "Microsoft Azure AD Inventory"
        },
        "config": {
            "name": "Azure AD Inventory",
            "tenant_id": "TenantID",
            "supported_apis": ["Devices", "Users"],
            "secret_key": "********",
            "application_id": "ApplicationID",
            "userSignInActivity": false,
            "userGroupDetails": false,
            "fields": {
                "_siemForward": false
            }
        },
        "sourceType": "Universal"
    }
}

Download example

Terraform example

resource "sumologic_cloud_to_cloud_source" "microsoft-azure-ad-inventory-source" {
  collector_id = sumologic_collector.collector.id
  schema_ref = {
    type = "Microsoft Azure AD Inventory"
  }
  config = jsonencode({
            "name": "Azure AD Inventory",
            "tenant_id": "TenantID",
            "supported_apis": ["Devices", "Users"],
            "secret_key": "********",
            "application_id": "ApplicationID",
            "userSignInActivity": false,
            "userGroupDetails": false,
            "fields": {
                "_siemForward": false
            }
  })
}
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.