New-PrintixUser
This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.
SYNOPSIS
Creates a normal or guest user.
SYNTAX
New-PrintixUser [[-TenantId] <String>] [-Email] <String> [-FullName] <String> [-Role] <String>
[[-Pin] <SecureString>] [[-Password] <SecureString>] [[-ExpirationTimestamp] <String>]
[[-SendWelcomeEmail] <Boolean>] [[-SendExpirationEmail] <Boolean>] [-Raw] [-ProgressAction <ActionPreference>]
[-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Creates a normal or guest user. Uses the documented Printix Cloud Print API. Required application type: User manager for role USER; User manager, Cloud Print API, or Card registration (API terminology) for role GUEST_USER. Requires Printix Premium.
EXAMPLES
EXAMPLE 1
New-PrintixUser -TenantId $tenantId -Email $email -FullName $fullName -Role $role
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
-Email
The Email value sent to Printix.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-FullName
The FullName value sent to Printix.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Role
The Role value sent to Printix.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 4
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Pin
The Pin value sent to Printix.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 5
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-Password
The Password value sent to Printix.
Type: SecureString
Parameter Sets: (All)
Aliases:
Required: False
Position: 6
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ExpirationTimestamp
The ExpirationTimestamp value sent to Printix.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: 7
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-SendWelcomeEmail
The SendWelcomeEmail value sent to Printix.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 8
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-SendExpirationEmail
The SendExpirationEmail value sent to Printix.
Type: Boolean
Parameter Sets: (All)
Aliases:
Required: False
Position: 9
Default value: False
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.