Using Get-MgUserLicenseDetail in Graph PowerShell

The Get-MgUserLicenseDetail cmdlet retrieves detailed information about the licenses assigned to a user in Microsoft 365. This information includes the specific licenses and service plans assigned to the user.

Prerequisites

To use the Get-MgUserLicenseDetail cmdlet,

• You should have M365 administrator role assigned to you.
• You should possess "User.Read.All" or "Directory.Read.All" Graph API permission scope.

Basic Syntax

Here’s the basic syntax of the Get-MgUserLicenseDetail cmdlet: Get-MgUserLicenseDetail -UserId <String> [<CommonParameters>]

• -UserId <String>: Use this parameter to specify the ID of the user for whom you want to retrieve license details. The UserId can be the user's UserPrincipalName (email) or ObjectId (GUID).
• <CommonParameters>: These are common parameters supported by many PowerShell cmdlets. They provide additional functionality such as specifying the output format, error handling, and more..

Usage Examples

Get License Details of a Specific User I

You should pass in the User Id or the UserPrincipalName to the Get-MgUserLicenseDetail cmdlet.

Get License Details of a Specific User II

You can also pass -All to Get-MgUserLicenseDetail cmdlet. In this case, the console requires you to supply the UserPrincipalName or User Id to get the user license details.

Get License Details of Multiple Users

You can also get the license details of multiple users by looping the user list and executing Get-MgUserLicenseDetail cmdlet.

$users = @("kimmy@7xh7fj.onmicrosoft.com","samadmin@7xh7fj.onmicrosoft.com","LeeG@7xh7fj.onmicrosoft.com")
foreach($user in $users) {
Get-MgUserLicenseDetail -UserId $user
}

Exporting License Details of Multiple Users to CSV File

The best way to get license of multiple users is to use Get-MgUser cmdlet along with Get-MgUserLicenseDetail cmdlet and export the license details to a CSV file.

$users = Get-MgUser -All
foreach($user in $users) {
Get-MgUserLicenseDetail -UserId $user.Id | Export-Csv -Path "d:/WeekyUserLicenseDetails.csv" -NoTypeInformation -Append
}

Getting the Service Plans

If you format-list the output from Get-MgUserLicenseDetail cmdlet, you'll get the service plans associated with the user.

Get-MgUserLicenseDetail -UserId "samadmin@7xh7fj.onmicrosoft.com" | Format-List

Find Disabled Service Plans for a User

Connect-MgGraph -Scopes "User.Read.All", "Directory.Read.All"
$UserId = "user@domain.com"
Get-MgUserLicenseDetail -UserId $UserId |
ForEach-Object {
    $License = $_
    $License.ServicePlans |
    Where-Object { $_.ProvisioningStatus -ne "Success" } |
    Select-Object `
        @{Name="SkuPartNumber";Expression={$License.SkuPartNumber}},
        ServicePlanName,
        ServicePlanId,
        ProvisioningStatus,
        AppliesTo
}

                    

What this script does

This script retrieves the licenses assigned to a user and identifies service plans that are not successfully provisioned.

Why this example is useful

This helps admins troubleshoot cases where a user has a license assigned but cannot access a specific Microsoft 365 service such as Exchange Online, Teams, SharePoint, or Planner.

Tips for Using Get-MgUserLicenseDetail

Here are some tips to keep in mind while using the Get-MgUserLicenseDetail cmdlet in Microsoft Graph PowerShell:

• Ensure Appropriate Permissions: Make sure you have the necessary permissions to run the Get-MgUserLicenseDetail cmdlet. Typically, you need the User.Read.All or Directory.Read.All permission.
• Authentication: Always authenticate to Microsoft Graph using Connect-MgGraph before running the cmdlet. Specify the required permissions to ensure you have access to the necessary data.
• Filtering Results: If you only need specific license details, filter the results using PowerShell filtering techniques to reduce the amount of data you need to process.
• Combining with Other Cmdlets: Combine Get-MgUserLicenseDetail with other cmdlets like Get-MgUser to get detailed user information along with license details.
• Exporting Data: Export the retrieved license details to a CSV file for further analysis and reporting. This is useful for audits and compliance checks.
• Handling Errors: Use error handling mechanisms to manage any issues that arise while running the cmdlet. This ensures your scripts are robust and can handle unexpected situations.

Use Cases for Get-MgUserLicenseDetail Cmdlet

• Audit License Usage: Regularly audit user licenses in your organization to ensure that licenses are being used efficiently and that there are no unused or underused licenses.
• License Management: Retrieve and manage user licenses to ensure that all necessary services are available to users and that costs are controlled.
• Scripting and Automation: Use this cmdlet in scripts to automate the process of retrieving license information and integrating it with other management tasks.

Frequently Asked Questions

• Can I retrieve license details for multiple users in a single call?

No, Get-MgUserLicenseDetail works on a per-user basis. You need to loop through each user to gather license details in bulk.

• Is there a way to check whether a user has access to specific Microsoft 365 services (e.g., Exchange, Teams)?

Yes, the ServicePlans property in the output shows enabled or disabled status for individual services tied to the license.

• Why do some users return no data when using Get-MgUserLicenseDetail?

This typically happens when the user does not have any license assigned or if the wrong user ID was specified.

• Can Get-MgUserLicenseDetail show disabled service plans?

Yes. The ServicePlans property shows individual service plans under each license. You can review the ProvisioningStatus value to identify whether a service plan is enabled, disabled, or not successfully provisioned.

Get-MgUserLicenseDetail -UserId "user@domain.com" |
Select-Object -ExpandProperty ServicePlans
                        


• What is the difference between SkuPartNumber and ServicePlanName?

SkuPartNumber refers to the assigned license, such as ENTERPRISEPACK or SPE_E3. ServicePlanName refers to an individual service inside that license, such as Exchange Online, Teams, SharePoint, or Planner.

A single license can contain multiple service plans.

Possible Errors and Solutions

Related Articles: