Get-DSEntryOTP

Synopsis

Get a PSObject containing the OTP code with the remaining time of an OTP entry and the corresponding end time (UTC)

Syntax

__AllParameterSets

Get-DSEntryOTP [-EntryID] <guid> [-AsLegacyResponse] [<CommonParameters>]

Description

Get a PSObject containing the OTP code with the remaining time of an OTP entry and the corresponding end time (UTC). The entry must be specified by its ID.

Examples

PS C:\> $response = Get-DSEntryOTP -EntryID '12345678-1234-1234-1234-123456789ABC'
        $otpCode = $response.code

Get the OTP code of the entry whose ID is '12345678-1234-1234-1234-123456789ABC'

Parameters

-AsLegacyResponse

In versions prior to 2024.2, many DS cmdlets returned a ServerResponse object. Enabling this backward compatibility switch allows scripts developed for earlier versions to function correctly.

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

-EntryID

ID of the entry for which you want to retrieve the OTP

Type: System.Guid
DefaultValue: ''
SupportsWildcards: false
Aliases: []
ParameterSets:
- Name: (All)
  Position: 0
  IsRequired: true
  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.

Notes

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