Get-GSUserLicense
SYNOPSIS
Gets the G Suite license information for a user or list of users
SYNTAX
List (Default)
Get-GSUserLicense [-PageSize <Int32>] [-Limit <Int32>] [-License <String>] [-ProductId <String[]>]
[<CommonParameters>]
Get
Get-GSUserLicense [[-User] <String[]>] [-CheckAll] [-License <String>] [<CommonParameters>]
DESCRIPTION
Gets the G Suite license information for a user or list of users
EXAMPLES
EXAMPLE 1
Get-GSUserLicense
Gets the full list of licenses for the customer
PARAMETERS
-User
The primary email or unique Id of the user to retrieve license information for
Type: System.String[]
Parameter Sets: Get
Aliases: PrimaryEmail, UserKey, Mail, UserId
Required: False
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-PageSize
The page size of the result set
Type: System.Int32
Parameter Sets: List
Aliases: MaxResults
Required: False
Position: Named
Default value: 1000
Accept pipeline input: False
Accept wildcard characters: False
-Limit
The maximum amount of results you want returned. Exclude or set to 0 to return all results
Type: System.Int32
Parameter Sets: List
Aliases: First
Required: False
Position: Named
Default value: 0
Accept pipeline input: False
Accept wildcard characters: False
-CheckAll
If $true, force a check of all license products when specifying a User. This will return all license types it finds for a specific user instead of the default behavior of short circuiting after matching against the first license assigned.
Type: System.Management.Automation.SwitchParameter
Parameter Sets: Get
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-License
{{ Fill License Description }}
Type: System.String
Parameter Sets: (All)
Aliases: SkuId
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProductId
{{ Fill ProductId Description }}
Type: System.String[]
Parameter Sets: List
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.