< Back
Invoke-FreeIPAAPIotptoken_add
Post
NAME Invoke-FreeIPAAPIotptoken_add
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIotptoken_add [[-type] <String>] [[-desc] <String>] [[-owner] <String>] [-disabled] [[-not_before]
<DateTime>] [[-not_after] <DateTime>] [[-vendor] <String>] [[-model] <String>] [[-serial] <String>] [[-key]
<String>] [[-algo] <String>] [[-digits] <String>] [[-offset] <Int32>] [[-interval] <Int32>] [[-counter] <Int32>]
[[-setattr] <String[]>] [[-addattr] <String[]>] [-qrcode] [-no_qrcode] [-all] [-raw] [[-version] <String>]
[-no_members] [[-id] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Add a new OTP token.
PARAMETERS
-type <String>
Type of the token
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
Token description (informational only)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-owner <String>
Assigned user of the token (default: self)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-disabled [<SwitchParameter>]
Mark the token as disabled (default: false)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-not_before <DateTime>
First date/time the token can be used
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_after <DateTime>
Last date/time the token can be used
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vendor <String>
Token vendor name (informational only)
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-model <String>
Token model (informational only)
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-serial <String>
Token serial (informational only)
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-key <String>
Token secret (Base32; default: random)
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-algo <String>
Token hash algorithm
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-digits <String>
Number of digits each token code will have
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-offset <Int32>
TOTP token / FreeIPA server time difference
Required? false
Position? 12
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-interval <Int32>
Length of TOTP token code validity
Required? false
Position? 13
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-counter <Int32>
Initial counter for the HOTP token
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-setattr <String[]>
Set an attribute to a name/value pair. Format is attr=value.
For multi-valued attributes, the command replaces the values already present.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-addattr <String[]>
Add an attribute/value pair. Format is attr=value. The attribute
must be part of the schema.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-qrcode [<SwitchParameter>]
(deprecated)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-no_qrcode [<SwitchParameter>]
Do not display QR code
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-id <String>
Unique ID
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
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
OUTPUTS
System.Management.Automation.PSObject
RELATED LINKS
SYNOPSIS
SYNTAX
Invoke-FreeIPAAPIotptoken_add [[-type] <String>] [[-desc] <String>] [[-owner] <String>] [-disabled] [[-not_before]
<DateTime>] [[-not_after] <DateTime>] [[-vendor] <String>] [[-model] <String>] [[-serial] <String>] [[-key]
<String>] [[-algo] <String>] [[-digits] <String>] [[-offset] <Int32>] [[-interval] <Int32>] [[-counter] <Int32>]
[[-setattr] <String[]>] [[-addattr] <String[]>] [-qrcode] [-no_qrcode] [-all] [-raw] [[-version] <String>]
[-no_members] [[-id] <String>] [-FullResultsOutput] [<CommonParameters>]
DESCRIPTION
Add a new OTP token.
PARAMETERS
-type <String>
Type of the token
Required? false
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-desc <String>
Token description (informational only)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-owner <String>
Assigned user of the token (default: self)
Required? false
Position? 3
Default value
Accept pipeline input? false
Accept wildcard characters? false
-disabled [<SwitchParameter>]
Mark the token as disabled (default: false)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-not_before <DateTime>
First date/time the token can be used
Required? false
Position? 4
Default value
Accept pipeline input? false
Accept wildcard characters? false
-not_after <DateTime>
Last date/time the token can be used
Required? false
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-vendor <String>
Token vendor name (informational only)
Required? false
Position? 6
Default value
Accept pipeline input? false
Accept wildcard characters? false
-model <String>
Token model (informational only)
Required? false
Position? 7
Default value
Accept pipeline input? false
Accept wildcard characters? false
-serial <String>
Token serial (informational only)
Required? false
Position? 8
Default value
Accept pipeline input? false
Accept wildcard characters? false
-key <String>
Token secret (Base32; default: random)
Required? false
Position? 9
Default value
Accept pipeline input? false
Accept wildcard characters? false
-algo <String>
Token hash algorithm
Required? false
Position? 10
Default value
Accept pipeline input? false
Accept wildcard characters? false
-digits <String>
Number of digits each token code will have
Required? false
Position? 11
Default value
Accept pipeline input? false
Accept wildcard characters? false
-offset <Int32>
TOTP token / FreeIPA server time difference
Required? false
Position? 12
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-interval <Int32>
Length of TOTP token code validity
Required? false
Position? 13
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-counter <Int32>
Initial counter for the HOTP token
Required? false
Position? 14
Default value 0
Accept pipeline input? false
Accept wildcard characters? false
-setattr <String[]>
Set an attribute to a name/value pair. Format is attr=value.
For multi-valued attributes, the command replaces the values already present.
Required? false
Position? 15
Default value
Accept pipeline input? false
Accept wildcard characters? false
-addattr <String[]>
Add an attribute/value pair. Format is attr=value. The attribute
must be part of the schema.
Required? false
Position? 16
Default value
Accept pipeline input? false
Accept wildcard characters? false
-qrcode [<SwitchParameter>]
(deprecated)
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-no_qrcode [<SwitchParameter>]
Do not display QR code
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-all [<SwitchParameter>]
Retrieve and print all attributes from the server. Affects command output.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-raw [<SwitchParameter>]
Print entries as stored on the server. Only affects output format.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-version <String>
Client version. Used to determine if server will accept request.
Required? false
Position? 17
Default value
Accept pipeline input? false
Accept wildcard characters? false
-no_members [<SwitchParameter>]
Suppress processing of membership attributes.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-id <String>
Unique ID
Required? false
Position? 18
Default value
Accept pipeline input? false
Accept wildcard characters? false
-FullResultsOutput [<SwitchParameter>]
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
OUTPUTS
System.Management.Automation.PSObject
RELATED LINKS