Search-TssFolder

SYNOPSIS

Search secret folders

SYNTAX

Search-TssFolder [-TssSession] <Session> [-ParentFolderId <Int32>] [-SearchText <String>]
 [-PermissionRequired <String[]>] [-SortBy <String>] [<CommonParameters>]

DESCRIPTION

Search secret folders

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssFolder -TssSession $session -ParentFolderId 54

Return all child folders found under root folder 54

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

-ParentFolderId

Parent Folder Id

Type: Int32
Parameter Sets: (All)
Aliases: FolderId

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

-SearchText

Search by text value

Type: String
Parameter Sets: (All)
Aliases:

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

-PermissionRequired

Filter based on folder permission (Owner, Edit, AddSecret, View). Default: View

Type: String[]
Parameter Sets: (All)
Aliases:

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

-SortBy

Sort by specific property, default FolderPath

Type: String
Parameter Sets: (All)
Aliases:

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

NOTES

Requires TssSession object returned by New-TssSession

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

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