Skip to main content

Connect-PrintixPartner

Generated Cmdlet Help

This page is generated from the Printix module. Edit the corresponding PowerShell source to update it.

SYNOPSIS​

Connects to the production Printix Partner API.

SYNTAX​

Connect-PrintixPartner [-ClientId] <String> [-ClientSecret] <SecureString> [-PartnerId] <String>
[-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION​

Required application type: partner API credentials issued out of band by Printix. These are separate from tenant applications created in Printix Administrator. Keeps a separate partner connection without replacing the Cloud Print connection. Access and refresh tokens are retained in memory only. Renewal uses the returned refresh token, or client credentials if no refresh token was supplied.

EXAMPLES​

EXAMPLE 1​

Connect-PrintixPartner -ClientId $clientId -ClientSecret (Read-Host 'Partner secret' -AsSecureString) -PartnerId $partnerId

PARAMETERS​

-ClientId​

The production partner client ID provided by Printix.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ClientSecret​

The production partner client secret as a SecureString.

Type: SecureString
Parameter Sets: (All)
Aliases:

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-PartnerId​

The default partner ID provided by Printix.

Type: String
Parameter Sets: (All)
Aliases:

Required: True
Position: 3
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.

INPUTS​

OUTPUTS​

System.Void​

NOTES​

https://printix.github.io/partner-api/#_authentication