Update-TssMetadataField

SYNOPSIS

Update metadata field for an item

SYNTAX

Update-TssMetadataField [-TssSession] <Session> -ItemId <Int32> -ItemType <MetadataType> -ItemDataId <Int32>
 -FieldDataType <MetadataFieldDataType> -FieldValue <Object> [-WhatIf] [-Confirm] [<CommonParameters>]

DESCRIPTION

Update metadata field for an item

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssMetadata -TssSession -ItemId 5 -ItemType User
Update-TssMetadataField -TssSession $session -ItemId 5 -ItemType User -ItemDataId 5 -FieldValue 2

Review output from search command to identify the sequence ID of the metadata field (5 as ItemDataId for this example) Update the value to 2

EXAMPLE 2

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssMetadata -TssSession -ItemId 5 -ItemType User
Update-TssMetadataField -TssSession $session -ItemId 5 -ItemType User -ItemDataId 5 -FieldValue 2

Review output from search command to identify the sequence ID of the metadata field (5 as ItemDataId for this example) Update the value to 2

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

-ItemId

Item ID

Type: Int32
Parameter Sets: (All)
Aliases:

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

-ItemType

Item Type

Type: MetadataType
Parameter Sets: (All)
Aliases:
Accepted values: Secret, User, Folder, Group

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

-ItemDataId

Item Value

Type: Int32
Parameter Sets: (All)
Aliases:

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

-FieldDataType

Field Data Type

Type: MetadataFieldDataType
Parameter Sets: (All)
Aliases:
Accepted values: String, Boolean, Number, DateTime, User

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

-FieldValue

Item Value

Type: Object
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
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

Thycotic.PowerShell.Folders.Folder

NOTES

Requires TssSession object returned by New-TssSession

https://thycotic-ps.github.io/thycotic.secretserver/commands/folders/Update-TssMetadataField

https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/folders/Update-TssMetadataField.ps1