Thycotic.SecretServer

0.44.0

functions/secret-templates/Update-SecretTemplateField.ps1

function Update-SecretTemplateField {
    <#
    .SYNOPSIS
    Update a field on a Secret Template
 
    .DESCRIPTION
    Update a field on a Secret Template
 
    .EXAMPLE
    $session = New-TssSession -SecretServer https://alpha -Credential $ssCred
    $template = Get-TssSecret -TssSession $session -TemplateId 6025
    $pwdField = $template.GetField('password')
    $pwdField.IsRequired = $true
    Update-TssSecretTemplateField -TssSession $session -TemplateId 6026 -Field $pwdField
 
    Gets current Password field on Template 6025 and updates IsRequired to be true
 
    .LINK
    https://thycotic-ps.github.io/thycotic.secretserver/commands/secret-templates/Update-TssSecretTemplateField
 
    .LINK
    https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/secret-templates/Update-SecretTemplateField.ps1
 
    .NOTES
    Requires TssSession object returned by New-TssSession
    #>
    [OutputType('TssSecretTemplateField')]
    [cmdletbinding(SupportsShouldProcess)]
    param(
        # TssSession object created by New-TssSession for auth
        [Parameter(Mandatory, ValueFromPipeline, Position = 0)]
        [TssSession]
        $TssSession,

        # Secret Template ID
        [Parameter(Mandatory, Position = 1)]
        [int]
        $TemplateId,

        # Secret Template Field (see example)
        [TssSecretTemplateField]
        $Field
    )
    begin {
        $updateParams = $PSBoundParameters
        $invokeParams = . $GetInvokeTssParams $TssSession
    }
    process {
        Write-Verbose "Provided command parameters: $(. $GetInvocation $PSCmdlet.MyInvocation)"
        if ($updateParams.ContainsKey('TssSession') -and $TssSession.IsValidSession()) {
            . $CheckVersion $TssSession '10.9.000000' $PSCmdlet.MyInvocation
            $restResponse = $null
            $uri = $TssSession.ApiUrl, 'secret-templates', $TemplateId -join '/'
            $invokeParams.Uri = $uri
            $invokeParams.Method = 'PUT'

            $invokeParams.Body = $Field | ConvertTo-Json
            if ($PSCmdlet.ShouldProcess("Secret Template ID: $TemplateId", "$($invokeParams.Method) $uri with: `n$($invokeParams.Body)")) {
                Write-Verbose "$($invokeParams.Method) $uri with: `n$($invokeParams.Body)"
                try {
                    $restResponse = . $InvokeApi @invokeParams
                } catch {
                    Write-Warning "Issue updating Secret Template [$TemplateId] field"
                    $err = $_
                    . $ErrorHandling $err
                }
                if ($restResponse) {
                    [TssSecretTemplateField]$restResponse
                }
            }
        } else {
            Write-Warning 'No valid session found'
        }
    }
}