Overview
The Entra Users - Version 6.1 collector retrieves per-user license assignment data and unassigned license counts from Microsoft Entra ID (formerly Azure Active Directory) using the Microsoft Graph API.
This collector provides visibility into which licenses are assigned to each user and how many purchased licenses remain unassigned, enabling organizations to validate subscriptions, allocate costs, and reconcile license usage within Varibill.
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 state of user license assignments 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 | Entra Users - Version 6.1 |
| Collection Behavior | Point in Time |
| Rating Model | Unrated |
| Vendor Name | Microsoft |
| Product | Microsoft Entra ID (Azure Active Directory) |
| Purpose | Retrieves per-user license assignments and unassigned license counts from Microsoft Entra ID for billing and validation 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.
License management in Microsoft Entra ID controls which users have access to which Microsoft services and products. Each license is associated with a SKU (Stock Keeping Unit) that contains one or more service plans, and licenses are assigned to individual users to grant access to those services.
Data Collected
The Entra Users - Version 6.1 collector retrieves unrated license assignment data from Microsoft Entra ID. The collector produces two categories of output records:
Per-User License Records
For each user with assigned licenses, the collector submits one record per license assignment. Each record represents a single SKU assigned to a single user. The quantity for each record is 1, reflecting that one license of that SKU is assigned to that user.
Each record includes the user’s display name, email address (user
principal name), department, and the SKU part number that identifies the
license type (for example, EXCHANGESTANDARD,
AAD_PREMIUM, FLOW_FREE).
Unassigned License Records
For each license SKU in the tenant, the collector submits a record representing the number of purchased licenses that are not currently assigned to any user. The quantity reflects the difference between the total enabled (purchased) licenses and the consumed (assigned) licenses for that SKU.
Note: The Entra Users - Version 6.1 collector reflects the state of Microsoft Entra ID at the time it runs. More frequent execution improves billing accuracy for environments with frequent license changes.
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:
User.Read.All— to retrieve user profile dataDirectory.Read.All— to retrieve license and subscription data
- 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 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.
Grouping Parameters
| Parameter | What it is | Default |
|---|---|---|
| Group Client Identifier By | Specifies which Microsoft Entra user attribute is used to group the Client Identifier submitted to Varibill. The attribute value is appended to the Tenant ID to form the Client Identifier. | givenName |
Note: The Client Identifier submitted to Varibill is constructed as
{Tenant ID}#{attribute value} when a grouping attribute is
configured. For example, with Group Client Identifier
By set to department, a user in the “Finance”
department would produce a Client Identifier of
1f344264-fb07-4465-babe-18df79ee1e8e#Finance.
If the attribute value is empty or null for a given user, only the Tenant ID is used as the Client Identifier.
Special value domain extracts the domain portion from
the user’s email address (the part after @) and uses it as
the grouping value.
Supported values include any valid Microsoft Entra user property such
as givenName, department,
companyName, city, country, or
domain.
The Product Identifier is the Microsoft SKU Part Number (for example,
EXCHANGESTANDARD, AAD_PREMIUM,
FLOW_FREE, SPB).
The Record Identifier for per-user records takes the form
A license is assigned to {display name} ({email}). For
unassigned license records, the Record Identifier is
Unassigned licences.
The Unique Identifier for per-user records is constructed as
{user ID}#{license assignment ID}. For unassigned license
records, the Unique Identifier is the SKU ID.
Ensure your Varibill product configuration accounts for these formats.
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
- Sign in to the Azure portal.
- Navigate to Microsoft Entra ID > App registrations and create a new application registration (or use an existing one).
- Note the Application (client) ID and the Directory (tenant) ID from the application’s Overview page.
- Navigate to API permissions and add the following
Microsoft Graph application permissions:
User.Read.AllDirectory.Read.All
- Click Grant admin consent to authorize the permissions.
- Navigate to Certificates & secrets > Client secrets and create a new client secret.
- Copy the Value of the client secret immediately — it is only displayed once.
Step 2: Configure the Collector in Varibill
In the Varibill User Interface, open the Source Collector configuration screen.
Enter the required field values under the Details tab:
- Hosting Provider: Select Varibill Cloud
- Source Collector Name: Select Entra Users - Version 6.1
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
Configure the grouping parameter:
- Group Client Identifier By: The Microsoft Entra
user attribute to use for grouping (for example,
department,givenName,companyName, ordomain)
- Group Client Identifier By: The Microsoft Entra
user attribute to use for grouping (for example,
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 users and licenses.
- 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
(
User.Read.All,Directory.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:
- There are licensed users in the Microsoft Entra ID tenant.
- The application registration has sufficient permissions to read user and license data.
- The Group Client Identifier By value corresponds to a valid Microsoft Entra user attribute.
Microsoft Entra ID References
The following resources may assist with locating values or configuring your Microsoft Entra ID application registration.
Microsoft Documentation (External)
- Microsoft Entra ID Documentation
- Microsoft Graph API Reference
- How to find your Microsoft Entra Tenant ID
- How to register an application in Microsoft Entra
- How to create a Client Secret
- How to grant Admin Consent
- Microsoft Entra User Properties
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
Feedback sent
We appreciate your effort and will try to fix the article