< Back
Get-AIMCredential
Post
NAME Get-AIMCredential
SYNOPSIS
Retrieves password from a local Credential Provider.
SYNTAX
Get-AIMCredential [-AppID] <String> [[-Safe] <String>] [[-Folder] <String>] [[-Object] <String>] [[-UserName]
<String>] [[-Address] <String>] [[-Database] <String>] [[-PolicyID] <String>] [[-QueryFormat] <String>]
[[-RequiredProps] <String[]>] [[-Reason] <String>] [[-Port] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]
DESCRIPTION
Sends a query via a local credential provider using the CLIPasswordSDK utility.
Use the Set-AIMConfiguration function to set the path to the CLIPasswordSDK executable.
PARAMETERS
-AppID <String>
Specifies the unique ID of the application issuing the password request.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Safe <String>
Specifies the name of the Safe where the password is stored.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Folder <String>
Specifies the name of the folder where the password is stored.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Object <String>
Specifies the name of the password object to retrieve.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UserName <String>
Defines search criteria according to the UserName account property.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Address <String>
Defines search criteria according to the Address account property.
Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Database <String>
Defines search criteria according to the Database account property.
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PolicyID <String>
Defines search criteria according to the PolicyID account property.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-QueryFormat <String>
Whether to search via "exact" or "regex" terms
Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-RequiredProps <String[]>
Defines the names of the account properties you want to be returned in addition to the Password
Required? false
Position? 10
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Reason <String>
The reason for retrieving the password. This reason will be audited in the Credential Provider audit log
Required? false
Position? 11
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Port <Int32>
The port to communicate with the credential provider
Required? false
Position? 12
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Timeout <Int32>
Timeout value in seconds
Required? false
Position? 13
Default value 0
Accept pipeline input? true (ByPropertyName)
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AIMCredential -AppID YourApp -Safe YourSafe -Folder Root -UserName YourUser
Returns the password found via the query definition:
Password PasswordChangeInProcess
-------- -----------------------
YourPass false
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-AIMCredential -AppID YourApp -Safe YourSafe -UserName YourUser -RequiredProps Address,UserName
Returns the password, address and username properties:
Password PasswordChangeInProcess UserName Address
-------- ----------------------- -------- -------
YourPass false YourUser DOMAIN.COM
RELATED LINKS
SYNOPSIS
Retrieves password from a local Credential Provider.
SYNTAX
Get-AIMCredential [-AppID] <String> [[-Safe] <String>] [[-Folder] <String>] [[-Object] <String>] [[-UserName]
<String>] [[-Address] <String>] [[-Database] <String>] [[-PolicyID] <String>] [[-QueryFormat] <String>]
[[-RequiredProps] <String[]>] [[-Reason] <String>] [[-Port] <Int32>] [[-Timeout] <Int32>] [<CommonParameters>]
DESCRIPTION
Sends a query via a local credential provider using the CLIPasswordSDK utility.
Use the Set-AIMConfiguration function to set the path to the CLIPasswordSDK executable.
PARAMETERS
-AppID <String>
Specifies the unique ID of the application issuing the password request.
Required? true
Position? 1
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Safe <String>
Specifies the name of the Safe where the password is stored.
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue)
Accept wildcard characters? false
-Folder <String>
Specifies the name of the folder where the password is stored.
Required? false
Position? 3
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Object <String>
Specifies the name of the password object to retrieve.
Required? false
Position? 4
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-UserName <String>
Defines search criteria according to the UserName account property.
Required? false
Position? 5
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Address <String>
Defines search criteria according to the Address account property.
Required? false
Position? 6
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Database <String>
Defines search criteria according to the Database account property.
Required? false
Position? 7
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-PolicyID <String>
Defines search criteria according to the PolicyID account property.
Required? false
Position? 8
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-QueryFormat <String>
Whether to search via "exact" or "regex" terms
Required? false
Position? 9
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-RequiredProps <String[]>
Defines the names of the account properties you want to be returned in addition to the Password
Required? false
Position? 10
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Reason <String>
The reason for retrieving the password. This reason will be audited in the Credential Provider audit log
Required? false
Position? 11
Default value
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Port <Int32>
The port to communicate with the credential provider
Required? false
Position? 12
Default value 0
Accept pipeline input? true (ByPropertyName)
Accept wildcard characters? false
-Timeout <Int32>
Timeout value in seconds
Required? false
Position? 13
Default value 0
Accept pipeline input? true (ByPropertyName)
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
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-AIMCredential -AppID YourApp -Safe YourSafe -Folder Root -UserName YourUser
Returns the password found via the query definition:
Password PasswordChangeInProcess
-------- -----------------------
YourPass false
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-AIMCredential -AppID YourApp -Safe YourSafe -UserName YourUser -RequiredProps Address,UserName
Returns the password, address and username properties:
Password PasswordChangeInProcess UserName Address
-------- ----------------------- -------- -------
YourPass false YourUser DOMAIN.COM
RELATED LINKS