< Back
Import-PasswordStateApiKey
Post
NAME Import-PasswordStateApiKey
SYNOPSIS
Imports a PasswordState API key.
SYNTAX
Import-PasswordStateApiKey [-Name] <String[]> [[-Repository] <String>] [<CommonParameters>]
DESCRIPTION
Imports a given PasswordState API key from the repository.
PARAMETERS
-Name <String[]>
Name of the key to retrieve. Do not include the file extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Repository <String>
Path to repository. Default is $env:USERPROFILE\\.passwordstate
Required? false
Position? 2
Default value (_GetDefault -Option 'credential_repository')
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 --------------------------
$cred = Import-PasswordStateApiKey -Name personal
Import the 'personal' API key from the default repository location.
-------------------------- EXAMPLE 2 --------------------------
$cred = Import-PasswordStateApiKey -Name personal -Repository c:\\users\\joe\\data\\.customrepo
Import the 'personal' API key from the 'c:\\users\\joe\\data\\.customrepo' repository.
RELATED LINKS
SYNOPSIS
Imports a PasswordState API key.
SYNTAX
Import-PasswordStateApiKey [-Name] <String[]> [[-Repository] <String>] [<CommonParameters>]
DESCRIPTION
Imports a given PasswordState API key from the repository.
PARAMETERS
-Name <String[]>
Name of the key to retrieve. Do not include the file extension.
Required? true
Position? 1
Default value None
Accept pipeline input? True (ByPropertyName, ByValue)
Accept wildcard characters? false
-Repository <String>
Path to repository. Default is $env:USERPROFILE\\.passwordstate
Required? false
Position? 2
Default value (_GetDefault -Option 'credential_repository')
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 --------------------------
$cred = Import-PasswordStateApiKey -Name personal
Import the 'personal' API key from the default repository location.
-------------------------- EXAMPLE 2 --------------------------
$cred = Import-PasswordStateApiKey -Name personal -Repository c:\\users\\joe\\data\\.customrepo
Import the 'personal' API key from the 'c:\\users\\joe\\data\\.customrepo' repository.
RELATED LINKS