Set-PasswordStateDocument

NAME Set-PasswordStateDocument



SYNOPSIS

Attach a document to an existing Password or PasswordList





SYNTAX

Set-PasswordStateDocument -ApiKey <PSCredential> [-Confirm] -DocumentDescription <String> -DocumentName <String>

-DocumentPath <String> [-Endpoint <String>] -PasswordId <Int32> [-WhatIf] [<CommonParameters>]



Set-PasswordStateDocument -ApiKey <PSCredential> [-Confirm] -DocumentDescription <String> -DocumentName <String>

-DocumentPath <String> [-Endpoint <String>] -PasswordListId <Int32> [-WhatIf] [<CommonParameters>]





DESCRIPTION

Attach a document to an existing Password or PasswordList





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



-Confirm [<SwitchParameter>]

Confirm action before executing.



Required? false

Position? named

Default value False

Accept pipeline input? False

Accept wildcard characters? false



-DocumentDescription <String>

The description of the document shown in PasswordState



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DocumentName <String>

The name of the file to be displayed in PasswordState, this is also the name used, when the file is downloaded

from PasswordState.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-DocumentPath <String>

This is the path to the file, that is to be uploaded to PasswordState



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-Endpoint <String>

The Uri of your PasswordState site.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PasswordId <Int32>

The ID of the password that you want to attach a document to.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-PasswordListId <Int32>

The ID of the password list that you want to attach a document to.



Required? true

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? false



-WhatIf [<SwitchParameter>]

Do not create a new password entry, just show -WhatIf message.



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

None







OUTPUTS

System.Object







NOTES









-------------------------- Example 1 --------------------------



PS C:\\> Set-PasswordStateDocument -ApiKey $key -PasswordListId 1 -DocumentPath "C:\\temp\\Secure.txt" -DocumentName

SecureDoc.txt -DocumentDescription 'My Very Secure Document'



Adds the document c:\\temp\\Secure.txt to the Password list with ID 1



RELATED LINKS