Get-PrintixUser
This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.
SYNOPSIS
Retrieves a user by ID.
SYNTAX
Get-PrintixUser [[-TenantId] <String>] [-UserId] <String> [-Raw] [-ProgressAction <ActionPreference>]
[<CommonParameters>]
DESCRIPTION
Retrieves a user by ID. Uses the documented Printix Cloud Print API. Required application type: Card registration (API terminology). Requires Printix Premium. User manager is not listed for this endpoint, even though it can list users.
EXAMPLES
EXAMPLE 1
Get-PrintixUser -TenantId $tenantId -UserId $userId
PARAMETERS
-TenantId
The tenant ID. Defaults to the tenant selected by Connect-Printix.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-UserId
The UserId path identifier.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Raw
Return the complete HAL document, including links and metadata.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction
Controls progress-record handling. Available in PowerShell 7.4 and later.
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
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.