Search-TssSecret

SYNOPSIS

Search for a secret

SYNTAX

filter (Default)

Search-TssSecret [-TssSession] <Session> [-FolderId <Int32>] [-IncludeSubFolders] [-Field <String>]
 [-SearchText <String>] [-ExactMatch] [-FieldSlug <String>] [-ExtendedField <String[]>]
 [-ExtendedTypeId <Int32>] [-SecretTemplateId <Int32>] [-SiteId <Int32>]
 [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
 [-PasswordTypeIds <Int32[]>] [-Permission <SecretPermissions>] [-Scope <String>] [-ExcludeDoubleLock]
 [-DoubleLockId <Int32>] [-SortBy <String>] [<CommonParameters>]
  

folder

Search-TssSecret [-TssSession] <Session> [-FolderId <Int32>] [-IncludeSubFolders] [-SortBy <String>]
 [<CommonParameters>]
  

field

Search-TssSecret [-TssSession] <Session> [-Field <String>] [-SearchText <String>] [-ExactMatch]
 [-FieldSlug <String>] [-ExtendedField <String[]>] [-ExtendedTypeId <Int32>] [-SortBy <String>]
 [<CommonParameters>]
  

secret

Search-TssSecret [-TssSession] <Session> [-SecretTemplateId <Int32>] [-SiteId <Int32>]
 [-HeartbeatStatus <SecretHeartbeatStatus>] [-IncludeInactive] [-ExcludeActive] [-RpcEnabled] [-SharedWithMe]
 [-PasswordTypeIds <Int32[]>] [-ExcludeDoubleLock] [-DoubleLockId <Int32>] [-SortBy <String>]
 [<CommonParameters>]
  

DESCRIPTION

Search for secrets using various filters provided by each parameter

EXAMPLES

EXAMPLE 1

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -FolderId 50
  

Return all secrets found with a folder ID of 50

EXAMPLE 2

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -FolderId 50 -SecretTemplateId 6001
  

Return all secrets using Secret Template 6001 that are found in FolderID 50.

EXAMPLE 3

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -SecretTemplateId 6047 -IncludeInactive
  

Return all secrets using Secret Template 6047 that are active and inactive.

EXAMPLE 4

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -SecretName 'Azure'
  

Return all secrets that have Azure in the name of the Secret (wildcard search)

EXAMPLE 5

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -SecretName 'Azure Test Account' -ExactMatch
  

Return all secret(s) that have the exact name "Azure Test Account"

EXAMPLE 6

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -Field username -SearchText 'root'
  

Return all secret(s) that contain "root" in the username field value

EXAMPLE 7

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -FolderId 85
  

Return all secret(s) contained in Folder ID 85

EXAMPLE 8

$session = New-TssSession -SecretServer https://alpha -Credential $ssCred
Search-TssSecret -TssSession $session -FolderId 85 -IncludeSubFolders
  

Return all secret(s) contained in Folder ID 85 and any child folders.

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
  

-FolderId

Returns only secrets within the specified folder.

Type: Int32
Parameter Sets: filter, folder
Aliases:

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

-IncludeSubFolders

Whether to include secrets in subfolders of the specified folder.

Type: SwitchParameter
Parameter Sets: filter, folder
Aliases: IncludeSubFolder

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

-Field

Field to filter on

Type: String
Parameter Sets: filter, field
Aliases:

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

-SearchText

Text of the field to filter on

Type: String
Parameter Sets: filter, field
Aliases: SecretName

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

-ExactMatch

Whether to do an exact match of the search text or a partial match. If an exact match, the entire secret name, field value, or list option in a list field must match the search text.

Type: SwitchParameter
Parameter Sets: filter, field
Aliases:

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

-FieldSlug

Field-slug to search This overrides the Field filter

Type: String
Parameter Sets: filter, field
Aliases:

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

-ExtendedField

An array of names of Secret Template fields to return. Only exposed fields can be returned.

Type: String[]
Parameter Sets: filter, field
Aliases: ExtendedFields

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

-ExtendedTypeId

If not null, return only secrets matching the specified extended mapping type as defined on the secret's template.

Type: Int32
Parameter Sets: filter, field
Aliases:

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

-SecretTemplateId

Return only secrets matching a certain template

Type: Int32
Parameter Sets: filter, secret
Aliases: TemplateId

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

-SiteId

Return only secrets within a certain site

Type: Int32
Parameter Sets: filter, secret
Aliases:

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

-HeartbeatStatus

Return only secrets with a certain heartbeat status

Type: SecretHeartbeatStatus
Parameter Sets: filter, secret
Aliases:
Accepted values: Failed, Success, Pending, Disabled, UnableToConnect, UnknownError, IncompatibleHost, AccountLockedOut, DnsMismatch, UnableToValidateServerPublicKey, Processing, ArgumentError, AccessDenied

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

-IncludeInactive

Include inactive/disabled secrets

Type: SwitchParameter
Parameter Sets: filter, secret
Aliases:

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

-ExcludeActive

Exclude active secrets

Type: SwitchParameter
Parameter Sets: filter, secret
Aliases:

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

-RpcEnabled

Secrets where template has RPC Enabled

Type: SwitchParameter
Parameter Sets: filter, secret
Aliases:

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

-SharedWithMe

Secrets where you are not the owner and secret is explicitly shared with your user

Type: SwitchParameter
Parameter Sets: filter, secret
Aliases:

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

-PasswordTypeIds

Secrets matching certain password types

Type: Int32[]
Parameter Sets: filter, secret
Aliases:

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

-Permission

Filter based on permission (List, View, Edit or Owner)

Type: SecretPermissions
Parameter Sets: filter
Aliases:
Accepted values: List, View, Edit, Owner

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

-Scope

Filter All Secrets, Recent or Favorites

Type: String
Parameter Sets: filter
Aliases:

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

-ExcludeDoubleLock

Exclude DoubleLocks from search results

Type: SwitchParameter
Parameter Sets: filter, secret
Aliases: ExcludeDoubleLocks

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

-DoubleLockId

Only include Secrets with this DoubleLock ID assigned in the search results.

Type: Int32
Parameter Sets: filter, secret
Aliases:

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

-SortBy

Sort by specific property, default Name

Type: String
Parameter Sets: (All)
Aliases:

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

NOTES

Requires TssSession object returned by New-TssSession

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

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