Register-PrintixCard
This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.
SYNOPSIS
Registers a converted, base64-encoded card number for a user.
SYNTAX
Register-PrintixCard [[-TenantId] <String>] [-UserId] <String> [-Secret] <SecureString> [-Raw]
[-ProgressAction <ActionPreference>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Registers a converted, base64-encoded card number for a user. Uses the documented Printix Cloud Print API. Required application type: Card manager.
EXAMPLES
EXAMPLE 1
Register-PrintixCard -TenantId $tenantId -UserId $userId -Secret $secret
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
-Secret
The Secret value sent to Printix.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
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
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: wi
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf
Required: False
Position: Named
Default value: None
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.