Search-TssMetadata

SYNOPSIS

Search metadata

SYNTAX

item

Search-TssMetadata [-TssSession] <Session> -ItemId <Int32> -ItemType <MetadataType> [-SortBy <String>]
 [<CommonParameters>]

field

Search-TssMetadata [-TssSession] <Session> [-FieldId <Int32>] [-SortBy <String>] [<CommonParameters>]

DESCRIPTION

Search metadata

When searching based on Item ID the account used must have the proper permissions on that object before metadata data can be returned

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssMetadata -TssSession $session -ItemId 46 -MetadataFieldId 4

Return Field ID 4 on object Item ID 46

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: False
Accept wildcard characters: False

-ItemId

Item ID to return metadata

Type: Int32
Parameter Sets: item
Aliases:

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

-FieldId

Metadata Field ID

Type: Int32
Parameter Sets: field
Aliases:

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

-ItemType

Item Type (Secret, User, Folder, Group)

Type: MetadataType
Parameter Sets: item
Aliases: MetadataType
Accepted values: Secret, User, Folder, Group

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

-SortBy

Sort by specific property, default ItemId

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: ItemId
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.Metadata.Summary

NOTES

Requires TssSession object returned by New-TssSession

https://thycotic-ps.github.io/thycotic.secretserver/commands/Search-TssMetadata

https://github.com/thycotic-ps/thycotic.secretserver/blob/main/src/functions/metadata/Search-TssMetadata.ps1