< Back
Find-PasswordStatePassword
Post
NAME Find-PasswordStatePassword
SYNOPSIS
Finds a password entries using criteria
SYNTAX
Find-PasswordStatePassword -ApiKey <PSCredential> [-Endpoint <String>] -PasswordListId <Int32> [-Title <String>]
[-Username <String>] [-Description <String>] [-GenericField1 <String>] [-GenericField2 <String>] [-GenericField3
<String>] [-GenericField4 <String>] [-GenericField5 <String>] [-GenericField6 <String>] [-GenericField7 <String>]
[-GenericField8 <String>] [-GenericField9 <String>] [-GenericField10 <String>] [-Notes <String>] [-Url <String>]
[-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Format <String>] [-UseV6Api] [<CommonParameters>]
Find-PasswordStatePassword -SystemApiKey <PSCredential> [-Endpoint <String>] [-Title <String>] [-Username
<String>] [-Description <String>] [-GenericField1 <String>] [-GenericField2 <String>] [-GenericField3 <String>]
[-GenericField4 <String>] [-GenericField5 <String>] [-GenericField6 <String>] [-GenericField7 <String>]
[-GenericField8 <String>] [-GenericField9 <String>] [-GenericField10 <String>] [-Notes <String>] [-Url <String>]
[-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Format <String>] [-UseV6Api] [<CommonParameters>]
Find-PasswordStatePassword [-Endpoint <String>] -PasswordListId <Int32> -SearchString <String> [-UseV6Api]
[<CommonParameters>]
DESCRIPTION
Finds a password entries using criteria
PARAMETERS
-ApiKey <PSCredential>
The API key for the password list in PasswordState.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SystemApiKey <PSCredential>
The system API key for PasswordState.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Endpoint <String>
The Uri of your PasswordState site. (i.e. https://passwordstate.local)
Required? false
Position? named
Default value (_GetDefault -Option 'api_endpoint')
Accept pipeline input? False
Accept wildcard characters? false
-PasswordListId <Int32>
The Id of the password list in PasswordState.
Required? true
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-SearchString <String>
Search text
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Title <String>
Search for text in Title field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Username <String>
Search for text in Username field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Search for text in Description field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField1 <String>
Search for text in GenericField1 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField2 <String>
Search for text in GenericField2 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField3 <String>
Search for text in GenericField3 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField4 <String>
Search for text in GenericField4 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField5 <String>
Search for text in GenericField5 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField6 <String>
Search for text in GenericField6 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField7 <String>
Search for text in GenericField7 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField8 <String>
Search for text in GenericField8 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField9 <String>
Search for text in GenericField9 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField10 <String>
Search for text in GenericField10 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Notes <String>
Search for text in Notes field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Url <String>
Search for text in Url field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpireBefore <DateTime>
Search passwords expiring before this date
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpireAfter <DateTime>
Search passwords expiring after this date
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Format <String>
The response format from PasswordState. Choose either json or xml.
Required? false
Position? named
Default value Json
Accept pipeline input? False
Accept wildcard characters? false
-UseV6Api [<SwitchParameter>]
PasswordState versions prior to v7 did not support passing the API key in a HTTP header but instead expected
the API key to be passed as a query parameter. This switch is used for backwards compatibility with older
PasswordState versions.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- EXAMPLE 1 --------------------------
Find-PasswordStatePassword -ApiKey $key -PasswordListId 1 -Title 'test'
Find password in list ID 1 with 'test' in the title
RELATED LINKS
SYNOPSIS
Finds a password entries using criteria
SYNTAX
Find-PasswordStatePassword -ApiKey <PSCredential> [-Endpoint <String>] -PasswordListId <Int32> [-Title <String>]
[-Username <String>] [-Description <String>] [-GenericField1 <String>] [-GenericField2 <String>] [-GenericField3
<String>] [-GenericField4 <String>] [-GenericField5 <String>] [-GenericField6 <String>] [-GenericField7 <String>]
[-GenericField8 <String>] [-GenericField9 <String>] [-GenericField10 <String>] [-Notes <String>] [-Url <String>]
[-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Format <String>] [-UseV6Api] [<CommonParameters>]
Find-PasswordStatePassword -SystemApiKey <PSCredential> [-Endpoint <String>] [-Title <String>] [-Username
<String>] [-Description <String>] [-GenericField1 <String>] [-GenericField2 <String>] [-GenericField3 <String>]
[-GenericField4 <String>] [-GenericField5 <String>] [-GenericField6 <String>] [-GenericField7 <String>]
[-GenericField8 <String>] [-GenericField9 <String>] [-GenericField10 <String>] [-Notes <String>] [-Url <String>]
[-ExpireBefore <DateTime>] [-ExpireAfter <DateTime>] [-Format <String>] [-UseV6Api] [<CommonParameters>]
Find-PasswordStatePassword [-Endpoint <String>] -PasswordListId <Int32> -SearchString <String> [-UseV6Api]
[<CommonParameters>]
DESCRIPTION
Finds a password entries using criteria
PARAMETERS
-ApiKey <PSCredential>
The API key for the password list in PasswordState.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-SystemApiKey <PSCredential>
The system API key for PasswordState.
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Endpoint <String>
The Uri of your PasswordState site. (i.e. https://passwordstate.local)
Required? false
Position? named
Default value (_GetDefault -Option 'api_endpoint')
Accept pipeline input? False
Accept wildcard characters? false
-PasswordListId <Int32>
The Id of the password list in PasswordState.
Required? true
Position? named
Default value 0
Accept pipeline input? False
Accept wildcard characters? false
-SearchString <String>
Search text
Required? true
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Title <String>
Search for text in Title field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Username <String>
Search for text in Username field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Search for text in Description field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField1 <String>
Search for text in GenericField1 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField2 <String>
Search for text in GenericField2 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField3 <String>
Search for text in GenericField3 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField4 <String>
Search for text in GenericField4 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField5 <String>
Search for text in GenericField5 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField6 <String>
Search for text in GenericField6 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField7 <String>
Search for text in GenericField7 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField8 <String>
Search for text in GenericField8 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField9 <String>
Search for text in GenericField9 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-GenericField10 <String>
Search for text in GenericField10 field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Notes <String>
Search for text in Notes field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Url <String>
Search for text in Url field
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpireBefore <DateTime>
Search passwords expiring before this date
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-ExpireAfter <DateTime>
Search passwords expiring after this date
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Format <String>
The response format from PasswordState. Choose either json or xml.
Required? false
Position? named
Default value Json
Accept pipeline input? False
Accept wildcard characters? false
-UseV6Api [<SwitchParameter>]
PasswordState versions prior to v7 did not support passing the API key in a HTTP header but instead expected
the API key to be passed as a query parameter. This switch is used for backwards compatibility with older
PasswordState versions.
Required? false
Position? named
Default value False
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
-------------------------- EXAMPLE 1 --------------------------
Find-PasswordStatePassword -ApiKey $key -PasswordListId 1 -Title 'test'
Find password in list ID 1 with 'test' in the title
RELATED LINKS