freeipa/doc/api/otptoken_add.md

61 lines
1.6 KiB
Markdown
Raw Normal View History

[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
# otptoken_add
Add a new OTP token.
### Arguments
|Name|Type|Required
|-|-|-
|ipatokenuniqueid|:ref:`Str<Str>`|False
### Options
* no_qrcode : :ref:`Flag<Flag>` **(Required)**
* Default: False
* all : :ref:`Flag<Flag>` **(Required)**
* Default: False
* raw : :ref:`Flag<Flag>` **(Required)**
* Default: False
* no_members : :ref:`Flag<Flag>` **(Required)**
* Default: False
* type : :ref:`StrEnum<StrEnum>`
* Default: totp
* Values: ('totp', 'hotp', 'TOTP', 'HOTP')
* description : :ref:`Str<Str>`
* ipatokenowner : :ref:`Str<Str>`
* ipatokendisabled : :ref:`Bool<Bool>`
* ipatokennotbefore : :ref:`DateTime<DateTime>`
* ipatokennotafter : :ref:`DateTime<DateTime>`
* ipatokenvendor : :ref:`Str<Str>`
* ipatokenmodel : :ref:`Str<Str>`
* ipatokenserial : :ref:`Str<Str>`
* ipatokenotpkey : :ref:`OTPTokenKey<OTPTokenKey>`
* ipatokenotpalgorithm : :ref:`StrEnum<StrEnum>`
* Default: sha1
* Values: ('sha1', 'sha256', 'sha384', 'sha512')
* ipatokenotpdigits : :ref:`IntEnum<IntEnum>`
* Default: 6
* Values: (6, 8)
* ipatokentotpclockoffset : :ref:`Int<Int>`
* Default: 0
* ipatokentotptimestep : :ref:`Int<Int>`
* Default: 30
* ipatokenhotpcounter : :ref:`Int<Int>`
* Default: 0
* setattr : :ref:`Str<Str>`
* addattr : :ref:`Str<Str>`
* qrcode : :ref:`Flag<Flag>`
* Default: False
* version : :ref:`Str<Str>`
### Output
|Name|Type
|-|-
|result|Entry
|summary|Output
|value|PrimaryKey
[//]: # (ADD YOUR NOTES BELOW. THESE WILL BE PICKED EVERY TIME THE DOCS ARE REGENERATED. //end)
### Semantics
### Notes
### Version differences