Remove-TppCertificate

SYNOPSIS

Remove a certificate

SYNTAX

ByObject

Remove-TppCertificate -InputObject <TppObject> [-Force] [-TppSession <TppSession>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByPath

Remove-TppCertificate -Path <String> [-Force] [-TppSession <TppSession>] [-WhatIf] [-Confirm]
 [<CommonParameters>]

DESCRIPTION

Removes a Certificate object, all associated objects including pending workflow tickets, and the corresponding Secret Store vault information. All associations must be removed for the certificate to be removed. You must either be a Master Admin or have Delete permission to the Certificate object and to the Application and Device objects if they are to be deleted automatically with -Force

EXAMPLES

EXAMPLE 1

$cert | Remove-TppCertificate

Remove a certificate via pipeline

EXAMPLE 2

Remove-TppCertificate -Path '\ved\policy\my cert'

Remove a certificate

EXAMPLE 3

Remove-TppCertificate -Path '\ved\policy\my cert' -force

Remove a certificate and automatically remove all associations

PARAMETERS

-InputObject

TppObject which represents a unique object

Type: TppObject
Parameter Sets: ByObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Path

Path to the certificate to remove

Type: String
Parameter Sets: ByPath
Aliases: DN, CertificateDN

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-Force

Provide this switch to force all associations to be removed prior to certificate removal

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TppSession

Session object created from New-TppSession method. The value defaults to the script session object $TppSession.

Type: TppSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $Script:TppSession
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

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

InputObject or Path

OUTPUTS

None

NOTES

http://venafitppps.readthedocs.io/en/latest/functions/Remove-TppCertificate/

https://github.com/gdbarron/VenafiTppPS/blob/main/VenafiTppPS/Code/Public/Remove-TppCertificate.ps1

https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-DELETE-Certificates-Guid.php?tocpath=Web%20SDK%7CCertificates%20programming%20interface%7C_____9