Get-RDMEntryOTPKey

2024-10-28

Get-RDMEntryOTPKey

SYNOPSIS

Get the OTP key of an OTP entry

SYNTAX

Id

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

InputObject

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

ALIASES

This cmdlet has the following aliases,

DESCRIPTION

Get the OTP key of an OTP entry. The entry is either specified by its ID, or by the PSConnection obtained from Get-RDMEntry. When using the parameter ID, the parameter VaultMode can be used to specify to look in the Global vault or the User vault directly. If the parameter VaultMode is not used, the current vault will be searched, followed by the User and Global vaults. The TicketID and Comment parameters can be used to fill the log prompt. It is used to fill the prompt for comment on credentials viewed. This a setting of the data source or vault in the Common -> Logs tab. The user must have the rights to edit the entry to obtain the OTP key.

EXAMPLES

EXAMPLE 1

PS C:> Get-RDMEntry -Name MyOTPEntry | Get-RDMEntryOTPKey -AsPlainText

Get the OTP key of the entry named MyOTPEntry

EXAMPLE 2

PS C:> Get-RDMEntryOTPKey -ID $otpEntryID -VaultMode User -AsPlainText

Get the OTP key of the entry, in the user vault, whose ID is stored in the variable $otpEntry

PARAMETERS

-AsPlainText

Return the OTP key as plain text.

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

-Comment

Comment for the credential viewed log.

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
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 not an option No.
• Cancel: Cancel the yes/no/cancel prompt. No is the fallback option if there is not an option Cancel.

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

-ID

OTP entry's ID with the OTP key to extract

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

-InputObject

OTP entry obtained from Get-RDMEntry with the OTP key to extract

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

-TicketID

Ticket number for the credential viewed log

Type: System.String
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
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 data source.

Type: Devolutions.RemoteDesktopManager.VaultMode
DefaultValue: ''
SupportsWildcards: false
ParameterValue: []
Aliases: []
ParameterSets:
- Name: Id
  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 obtained from Get-DSEntry

OUTPUTS

NOTES

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

RELATED LINKS