Microsoft Entra Users by Group - Version 2.0

Modified on Wed, 19 Aug at 9:51 AM

Overview

The Microsoft Entra Users by Group - Version 2.0 collector retrieves the members of a specified Microsoft Entra ID security or Microsoft 365 group, submitting one record per user found in that group.

This collector enables organizations to track group membership for billing, allocation, or reporting purposes within Varibill. Each execution captures which users currently belong to a named Entra group, with a configurable Product Identifier that defines how the membership is represented as a billable item.

The collector retrieves unrated allocation data, meaning no monetary values are supplied by the source system. Pricing and billing calculations are applied within Varibill based on configured contracts and pricing rules.

This is a point-in-time collector, meaning each execution retrieves the current group membership at the time of collection.

For general instructions on creating and running Source Collectors, see: Configuring a New Cloud Source Collector

Collector Summary

Field Value
Source Collector Name Microsoft Entra Users by Group - Version 2.0
Collection Behavior Point in Time
Rating Model Unrated
Vendor Name Microsoft
Product Microsoft Entra ID (Azure Active Directory)
Purpose Retrieves the members of a specified Entra group for billing and allocation within Varibill

About Microsoft Entra ID

Microsoft Entra ID (formerly Azure Active Directory) is Microsoft’s cloud-based identity and access management service. It provides authentication, authorization, and directory services for organizations using Microsoft cloud services and applications.

Microsoft Entra ID manages user identities, application access, and security policies across an organization’s cloud environment. It is the identity backbone for Microsoft 365, Azure, and thousands of third-party SaaS applications.

Groups in Microsoft Entra ID are used to organize users for access control, licensing, and administration. Security groups and Microsoft 365 groups can contain users, devices, and other groups, and are commonly used to manage access to resources or to define service scopes.

Data Collected

The Microsoft Entra Users by Group - Version 2.0 collector retrieves unrated group membership data from Microsoft Entra ID. For each user that belongs to the specified group, the collector submits one record with a quantity of 1.

Each record includes the user’s display name, email address (user principal name), and the group’s display name.

The Product Identifier for all records is set to the configured Product Identifier parameter value (for example, SupportedUsers). This allows you to define how the group membership is represented as a product in Varibill.

The Client Identifier for all records is the Entra Tenant ID, identifying the tenant from which the data was collected.

The Record Identifier for each record takes the form The user {display name} ({email}) belongs to the group {group name}.

The Unique Identifier for each record is constructed as {group ID}#{user ID}, where both values are Microsoft Entra GUIDs.

Ensure your Varibill product configuration accounts for these formats.

Note: The Microsoft Entra Users by Group - Version 2.0 collector reflects the state of Microsoft Entra ID at the time it runs. Users added to or removed from the group between collection runs will be reflected in the next execution.

Prerequisites

Before configuring this collector, ensure that:

  • You have access to a Microsoft Entra ID tenant (Azure Active Directory)
  • You have permission to create or manage Application Registrations in the Azure portal
  • You have registered an application in Microsoft Entra ID with the following Microsoft Graph API application permissions:
    • Group.Read.All — to retrieve group data and membership
    • User.Read.All — to retrieve user profile data for group members
  • You have granted Admin Consent for the above API permissions
  • You have created a Client Secret for the application registration
  • You have noted the Tenant ID, Application (Client) ID, and Client Secret value
  • You know the exact display name of the Entra group you want to collect membership for
  • You have access to the Varibill Source Collector configuration screen

Tip: Client secrets are displayed only once when created in the Azure portal. Record and store the value securely before leaving the page. If lost, you will need to create a new client secret.

Warning! The Entra Secret Key grants API access to your Microsoft Entra ID environment. Store it securely and do not share it. The secret is masked in the Varibill UI once saved. If it is compromised, delete and regenerate the client secret immediately in the Azure portal.

Configuration Parameters

The parameters below are entered when configuring the collector in Varibill. They are grouped by function.

Connection Parameters

These parameters identify and authenticate against your Microsoft Entra ID tenant using OAuth 2.0 client credentials.

Parameter What it is Where to find it
Entra Tenant ID The unique identifier (GUID) of your Microsoft Entra ID tenant Azure Portal > Microsoft Entra ID > Overview > Tenant ID
Entra Application ID The Application (Client) ID of the registered application used for authentication Azure Portal > App registrations > Your app > Overview > Application (client) ID
Entra Secret Key The client secret credential used by Varibill to authenticate against the Microsoft Graph API Azure Portal > App registrations > Your app > Certificates & secrets > Client secrets

Warning! The Entra Secret Key is a sensitive credential. It is masked in the Varibill UI once saved. If it is compromised, delete and regenerate the client secret immediately in the Azure portal.

Group and Product Parameters

Parameter What it is Example
Entra Group Name The exact display name of the Microsoft Entra group whose members will be collected. The name must match the group’s display name in Microsoft Entra ID exactly, including spacing and capitalization. IT Support Users
Product Identifier The product code submitted to Varibill for each user record. This value becomes the Product Identifier for all records produced by this collector. Choose a value that maps to your Varibill product configuration. SupportedUsers

Note: The Entra Group Name must match the group’s display name in Microsoft Entra ID exactly. If the group is renamed in Entra, the parameter value must be updated to match.

The Product Identifier is a user-defined value — it is not derived from Microsoft Entra ID. Set it to match the product name configured in Varibill for billing this group’s membership.

Operational Parameters

These parameters control file management behavior.

Parameter What it is Default
Delete data files older than The number of days after which locally stored collection files are automatically deleted. Must be at least 1. 62
Maximum number of records per file The maximum number of records written to a single output file before a new file is started. Must be between 1,000 and 50,000. 10000

Configuration Steps

Step 1: Prepare Microsoft Entra ID

  1. Sign in to the Azure portal.
  2. Navigate to Microsoft Entra ID > App registrations and create a new application registration (or use an existing one).
  3. Note the Application (client) ID and the Directory (tenant) ID from the application’s Overview page.
  4. Navigate to API permissions and add the following Microsoft Graph application permissions:
    • Group.Read.All
    • User.Read.All
  5. Click Grant admin consent to authorize the permissions.
  6. Navigate to Certificates & secrets > Client secrets and create a new client secret.
  7. Copy the Value of the client secret immediately — it is only displayed once.
  8. Note the exact display name of the Entra group you want to collect membership for. Navigate to Microsoft Entra ID > Groups and confirm the name.

Step 2: Configure the Collector in Varibill

  1. In the Varibill User Interface, open the Source Collector configuration screen.

  2. Enter the required field values under the Details tab:

    • Hosting Provider: Select Varibill Cloud
    • Source Collector Name: Select Microsoft Entra Users by Group - Version 2.0
  3. Enter the connection parameters:

    • Entra Tenant ID: The Directory (tenant) ID from the Azure portal
    • Entra Application ID: The Application (client) ID from the Azure portal
    • Entra Secret Key: The client secret value
  4. Configure the group and product parameters:

    • Entra Group Name: The exact display name of the target group in Microsoft Entra ID
    • Product Identifier: The product code to use in Varibill (for example, SupportedUsers)
  5. Save the collector configuration.

Step 3: Run the Collector

Run or schedule the collector according to your standard Source Collector execution process.

For detailed instructions, see: Configuring a New Cloud Source Collector

Troubleshooting

If the collector fails to connect to Microsoft Entra ID, verify that:

  • The Entra Tenant ID is correct and matches the tenant containing your group.
  • The Entra Application ID is correct and corresponds to a valid application registration.
  • The Entra Secret Key is valid, has not expired, and has not been revoked.
  • The required Microsoft Graph API permissions (Group.Read.All, User.Read.All) have been granted to the application registration.
  • Admin Consent has been granted for the API permissions.

If the collector connects successfully but returns no data, verify that:

  • The Entra Group Name matches the group’s display name in Microsoft Entra ID exactly, including spacing and capitalization.
  • The group contains at least one member.
  • The application registration has sufficient permissions to read group membership data.

Microsoft Entra ID References

The following resources may assist with locating values or configuring your Microsoft Entra ID application registration.

Microsoft Documentation (External)

Note: Microsoft documentation is provided for reference. Steps and interface labels may vary depending on your Azure environment and permissions.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article