Get-RDMEntryPassword

Synopsis

Resolve the password of the specified entry

Syntax

Id

Get-RDMEntryPassword [-ID] <guid> [-Comment <string>] [-TicketID <string>] [-AsPlainText]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObject

Get-RDMEntryPassword [-InputObject] <PSConnection> [-Comment <string>] [-TicketID <string>]
 [-AsPlainText] [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

MyPersonalCredentials

Get-RDMEntryPassword -MyPersonalCredentials [-Comment <string>] [-TicketID <string>] [-AsPlainText]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

MyPrivilegedAccount

Get-RDMEntryPassword -MyPrivilegedAccount [-Comment <string>] [-TicketID <string>] [-AsPlainText]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Resolve the password of the specified entry. The entry can be specified in two way: by its ID and by passing the PSConnection object. When using the ID parameter, the VaultMode parameter can be used to search the entry in the user vault or in global vault. For the InputObjet parameter, the entry can be obtained from Get-RDMEntry, Get-RDMPersonalCredentials, and Get-RDMPrivilegedAccount. If the password has been modified locally via Set-RDMEntryPassword and the entry is a credential, the old password will be returned. To see the new password, Update-RDMEntries must be called. To obtain the password, the user must be able to copy it. Generally, this means the right to view it. However, in some cases, an adminstrator might be required or a non-empty password. The status of the entry, such as Locked or Expired, can also prevent the obtention of the password. If the workspace required a prompt on credentials viewed, the user will be prompted for each required field. To avoid this, the TicketID and Comment parameters must be used.

Examples

Example 1

PS C:\> Get-RDMEntryPassword -ID '00000000-0000-0000-0000-000000000000' -AsPlainText -VaultMode User

Obtain, as plain text, the password of the entry in the user vault whose ID is '00000000-0000-0000-0000-000000000000'

Example 2

PS C:\> Get-RDMEntry -Name 'MyCredEntry' -VaultMode Global | Get-RDMEntryPassword -TicketID 'tick101' -Comment 'Why not'

Obtain, as a SecureString, the password of the entry 'MyCredEntry' in the system vault. The ticket number and the comment are passed with the associated parameters to avoid being prompted.

Example 3

PS C:\> Get-RDMPersonalCredentials | Get-RDMEntryPassword -AsPlainText

Obtain, as a plain text, the password of 'My Personal Credentials' in the user settings.

Example 4

PS C:\> Get-RDMPrivilegedAccount | Get-RDMEntryPassword -AsPlainText

Obtain, as a plain text, the password of 'My Privileged Account' in the user settings.

Parameters

-AsPlainText

Return the password as plain text.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-Comment

Comment for the credential viewed log.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ForcePromptAnswer

Switch to use with caution. It will automatically answer prompt asking yes/no, yes/no/cancel, or ok/cancel questions. In case of multiple prompts, multiple values can be passed to this parameter. Here are the accepted values:

• Yes: Accept the prompt. Cover the OK and Automatic value.
• No: Refuse the yes/no/cancel prompt. "Cancel" is the fallback option if there is no "No" option.
• Cancel: Cancel the yes/no/cancel prompt. "No" is the fallback option if there is no "Cancel" option.

Type: System.Windows.Forms.DialogResult[]
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-ID

ID of the entry to get the password from.

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: Id
  Position: 0
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-InputObject

Entry to get the password from. Can be obtained from Get-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount.

Type: RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection
DefaultValue: ''
SupportsWildcards: false
Aliases:
- Session
ParameterSets:
- Name: InputObject
  Position: 0
  IsRequired: true
  ValueFromPipeline: true
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-MyPersonalCredentials

Obtain the password from 'My Personal Credentials'.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: MyPersonalCredentials
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-MyPrivilegedAccount

Obtain the password from 'My Privileged Account'.

Type: System.Management.Automation.SwitchParameter
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: MyPrivilegedAccount
  Position: Named
  IsRequired: true
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-TicketID

Ticket number for the credential viewed log

Type: System.String
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

-VaultMode

Vault where the command will be applied. Three choices are offered:

• Default: Current vault that has been set.
• User: Vault specific to the current user.
• Global: Global vault of the workspace.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: Named
  IsRequired: false
  ValueFromPipeline: false
  ValueFromPipelineByPropertyName: false
  ValueFromRemainingArguments: false
DontShow: false
AcceptedValues: []
HelpMessage: ''

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Inputs

RemoteDesktopManager.PowerShellModule.PSOutputObject.PSConnection

PSConnection object of the entry obtained from Get-RDMEntry, Get-RDMPersonalCredentials, or Get-RDMPrivilegedAccount

Notes

For more information, type "Get-Help Get-RDMEntryPassword -detailed". For technical information, type "Get-Help Get-RDMEntryPassword -full".