Open-TssSecret
SYNOPSIS
Checkout a Secret
SYNTAX
Open-TssSecret [-TssSession] <Session> [-Id <Int32[]>] [-Comment <String>] [-TicketNumber <String>]
[-TicketSystemId <Int32>] [-WhatIf] [-Confirm] [<CommonParameters>]
DESCRIPTION
Checkout a Secret
EXAMPLES
EXAMPLE 1
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Checkout-TssSecret -TssSession $session -Id 72 -TicketId 'N000354'
Checkout Secret ID 72 providing ticket number required by Ticket Integration
EXAMPLE 2
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Open-TssSecret -TssSession $session -Id 376
Checkout Secret ID 376
EXAMPLE 3
$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Open-TssSecret -TssSession $session -Id 42 -Comment "CI process"
Checkout Secret ID 42 providing a comment (Secret configured to checkout and require comment)
PARAMETERS
-TssSession
TssSession object created by New-TssSession for authentication
Type: Session
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False
-Id
Secret ID
Type: Int32[]
Parameter Sets: (All)
Aliases: SecretId
Required: False
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: False
-Comment
Comment to provide for restricted secret (Require Comment is enabled)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TicketNumber
Associated ticket number (required for ticket integrations)
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-TicketSystemId
Associated ticket system ID (required for ticket integrations)
Type: Int32
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: 0
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
OUTPUTS
NOTES
Requires TssSession object returned by New-TssSession
RELATED LINKS
https://thycotic-ps.github.io/thycotic.secretserver/commands/secrets/Open-TssSecret