Azure Active Directory

Community Platform

runZero integrates with Azure AD to allow you to sync and enrich your asset inventory, as well as gain visibility into Azure AD users and groups. Adding your Azure AD data to runZero makes it easier to find assets that are not part of your domain.

Getting started

To set up the Azure AD integration, you’ll need to:

1. Configure Azure AD to allow API access through runZero.
2. Add the Azure AD credential in runZero.
3. Choose whether to configure the integration as a scan probe or connector task.
4. Activate the Azure AD integration to sync your data with runZero.

Requirements

Before you can set up the Azure AD integration, make sure you have access to the Microsoft Azure portal.

Step 1: Register an Azure application for Azure AD API access

runZero can authenticate to the Azure AD API using either a username and password or a client secret. Register an application to configure Azure AD API access.

1. Log into the Microsoft Azure portal.
2. Go to Azure Active Directory > App registrations and click on New registration.
   • Provide a name.
   • Select the supported account types.
   • Optionally add a redirect URI.
3. Click Register to register the application.
4. Once the application is created, you should see the Overview dashboard. Note the following information:
   • Application (client) ID
   • Directory (tenant) ID
5. From the application’s details page, go to Authentication. Set Allow public client flows to Yes and then save the configuration.
6. Go to API permissions > Add a permission.
7. Select Microsoft Graph from the list of Microsoft APIs.
8. Select the correct permissions type for your needs:
   • Username & password: select Delegated permissions
   • Client secret: select Application permissions
9. Search for and select the following required permissions:
   • Device.Read.All
   • Group.Read.All
   • User.Read.All
10. Click Add permissions to save the permissions to the application.
11. If using a client secret, also perform the following steps:
    • Navigate to Azure Active Directory > App registrations and select the application you created.
    • Go to Certificates & secrets and click on New client secret.
      • Enter a description.
      • Select the expiration.
    • Click Add to create the client secret and save the client secret value.

Add the Azure AD credential to runZero

Step 2a: Add an Azure Username & Password credential to runZero

1. Go to the Credentials page in runZero and click Add Credential.
2. Provide a name for the credential, like Azure User/Pass.
3. Choose Azure Username & Password from the list of credential types.
4. Provide the following information:
   • Azure application (client) ID - The unique ID for the registered application. This can be found in the Azure portal if you go to Azure Active Directory > App registrations and select the application.
   • Azure directory (tenant) ID - The unique ID for the tenant. This can be found in the Azure portal if you go to Azure Active Directory > App registrations and select the application.
   • Azure username - The username for your Azure cloud account. This cannot be a federated user account.
   • Azure password - The password for your Azure cloud account.
5. If you want other organizations to be able to use this credential, select the Make this a global credential option. Otherwise, you can configure access on a per organization basis.
6. Save the credential. You’re now ready to set up and activate the connection to bring in data from Azure.

Step 2b: Add an Azure Client Secret credential to runZero

This type of credential can be used to sync all resources in a single directory (across multiple subscriptions).

1. Go to the Credentials page in runZero and click Add Credential.
2. Provide a name for the credential, like Azure Client Secret.
3. Choose Azure Client Secret from the list of credential types.
4. Provide the following information:
   • Azure application (client) ID - The unique ID for the registered application. This can be found in the Azure portal if you go to Azure Active Directory > App registrations and select the application.
   • Azure client secret - To generate a client secret, go to Azure Active Directory > App registrations, select your application, go to Certificates & secrets and click on New client secret.
   • Azure directory (tenant) ID - The unique ID for the tenant. This can be found in the Azure portal if you go to Azure Active Directory > App registrations and select the application.
   • Select the Access all subscriptions in this directory (tenant) option to sync all resources in your directory. Otherwise, specify the Azure subscription ID - The unique ID for the subscription that you want to sync. This can be found in the Azure portal if you go to Subscriptions and select the subscription.
5. If you want other organizations to be able to use this credential, select the Make this a global credential option. Otherwise, you can configure access on a per organization basis.
6. Save the credential. You’re now ready to set up and activate the connection to bring in data from Azure.

Step 3: Choose how to configure the AzureAD integration

The Azure AD integration can be configured as either a scan probe or a connector task. Scan probes gather data from integrations during scan tasks. Connector tasks run independently from either the cloud or one of your Explorers, only performing the integration sync.

Step 4: Set up and activate the Azure AD integration to sync data

After you add your Azure AD credential, you’ll need to set up a connector task or scan probe to sync your data.

Step 4a: Configure the Azure AD integration as a connector task

A connection requires you to set a schedule and choose a site. The schedule determines when the sync occurs, and the site determines where any new Azure AD-only assets are created.

1. Activate a connection to Azure AD. You can access all available third-party connections from the integrations page, your inventory, or the tasks page.
2. Choose the credential you added earlier. If you don’t see the credential listed, make sure it has access to the organization you are currently in.
3. Optionally provide a filter following the Microsoft Graph API filter syntax. We will only import devices that match the filter.
4. Enter a name for the task, like Azure AD sync.
5. Schedule the sync. A sync can be set to run on a recurring schedule or run once. The schedule will start on the date and time you have set.
6. Under Task configuration, choose the site you want to add your assets to.
7. If you want to exclude assets that have not been scanned by runZero from your integration import, switch the Exclude unknown assets toggle to Yes. By default, the integration will include assets that have not been scanned by runZero.
8. If you want to include assets in your integration import that the Azure AD account has marked as inactive, switch the Include inactive assets toggle to Yes. By default, the integration will not include assets that are marked as inactive.
9. Activate the connection when you are done. The sync will run on the defined schedule. You can always check the Scheduled tasks to see when the next sync will occur.

Step 4b: Configure the Azure AD integration as a scan probe

1. Create a new scan task or select a future or recurring scan task from your Tasks page.
2. Add or update the scan parameters based on any additional requirements.
3. On the Probes and SNMP tab, choose which additional probes to include, set the Azure AD toggle to Yes, and change any of the default options if needed.
4. On the Credentials tab, set the Azure AD toggle for the credential you wish to use to Yes.
5. Click Initialize scan to save the scan task and have it run immediately or at the scheduled time.

Step 5: View Azure AD assets

After a successful sync, you can go to your inventory to view your Azure AD assets. These assets will have an Active Directory icon listed in the Source column.

To filter by Azure AD assets, consider running the following queries:

• View all Azure AD assets:

  source:azuread
  

• View runZero assets not connected to Azure AD:

  source:runzero AND NOT source:azuread
  

Click into each asset to see its individual attributes. runZero will show you the attributes returned by Azure AD.

Community Platform

Filtering Azure AD assets

An optional filter can be applied to Azure AD integration tasks. runZero uses Microsoft Graph $filter query paramater to filter assets. GraphQL follows the syntax <property> [operator] <value>. Multiple expressions can be combined for more complex filtering by adding an and or or between expressions.

Properties

Any property that runZero imports from Azure AD can be used to apply a filter. The following are some examples.

Operators

The following are common operators that can be used in an Azure AD filter.

• Equal to (eq)
• Not equal to (ne)
• Has (has)
• Less than (lt)
• Greather than (gt)
• Less than or equal to (le)
• Greater than or equal to (ge)

The following are common functions that can be used in an Azure AD filter. Functions follow the syntax function(<property>, <value>).

• Starts with (startswith)
• Ends with (endswith)
• Contains (contains)

Example Filters

The following are examples of filters that can be applied to an Azure AD integration.

Troubleshooting

If you are having trouble using this integration, the questions and answers below may assist in your troubleshooting.

Why is the Azure Active Directory integration unable to connect?

1. Are you getting any data from the Azure AD integration?
   • Make sure to query the inventory rather than look at the task details to review all the data available from this integration.
   • In some cases, integrations have a configuration set that limits the amount of data that comes into the runZero console.
2. Some integrations require very specific actions that are easy to overlook. If a step is missed when setting up the intergration, it may not work correctly. Please review this documentation and follow the steps exactly.
3. If the Azure AD integration is unable to connect be sure to check the task log for errors. Some common errors include:
   • 500 - server error, unable to connect to the endpoint
   • 404 - hitting an unknown endpoint on the server
   • 403 - not authorized, likely a credential issue

How do I solve the following Azure AD errors?

• (invalid_client) AADSTS7000218: The request body must contain the following parameter: 'client_assertion' or 'client_secret'

  1. This error can be corrected by enabling Allow Public Client Flows in Azure AD. This can be accomplished by entering the Application details page under Authentication > Advanced Settings. From here you can toggle the Allow Public Client Flows setting to Yes.
  2. It can also be helpful to ensure that application permissions were granted correctly when registering the Azure application for Azure AD API access. To do this, navigate to the API permissions settings page and ensure that each of the API/Permissions have the type set to application. Also make sure that the permission granted is Grant Admin Consent for Default Directory.

• failed to get Azure AD groups: invalid response: 403 (403 Forbidden)

  1. This error is likely due to an issue with credentialing. Please review the documentation and check your credentials to ensure everything was entered correctly and no steps were accidentally skipped.