For the complete documentation index, see llms.txt. This page is also available as Markdown.

Get-RDMEntryOTP

Synopsis

Get a hastable of the OTP code with the remaining time of an OTP entry

Syntax

Id

Get-RDMEntryOTP [-ID] <guid> [-Comment <string>] [-TicketID <string>] [-PasswordListItemID <guid>]
 [-VaultMode <VaultMode>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

InputObject

Get-RDMEntryOTP [-InputObject] <PSConnection> [-Comment <string>] [-TicketID <string>]
 [-PasswordListItemID <guid>] [-ForcePromptAnswer <DialogResult[]>] [<CommonParameters>]

Description

Get a hastable of the OTP code with the remaining time of an OTP entry. To obtain the OTP code, the user must be able to copy it. Generally, this means the right to view it. The status of the entry, such as Locked or Expired, can also prevent the obtention of the OTP code. 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

PS C:\> $otp = Get-RDMEntry -Name MyOTPEntry | Get-RDMEntryOTP;
    $otp.Code

Get the OTP code of the entry MyOTPEntry

Parameters

-Comment

Comment for the credential viewed log.

-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.

-ID

ID of the entry to modify. Use the VaultMode parameter to search in the User vault or the Global vault.

-InputObject

Specifies the entry to get the OTP from.

-PasswordListItemID

For password list, the item's ID to be resolved.

-TicketID

Ticket number for the credential viewed log

-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.

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 OTP entry obtained from Get-RDMEntry

Notes

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

Last updated

Was this helpful?