Import Upstream version 4.12.4
This commit is contained in:
86
doc/api/user_mod.md
Normal file
86
doc/api/user_mod.md
Normal file
@@ -0,0 +1,86 @@
|
||||
[//]: # (THE CONTENT BELOW IS GENERATED. DO NOT EDIT.)
|
||||
# user_mod
|
||||
Modify a user.
|
||||
|
||||
### Arguments
|
||||
|Name|Type|Required
|
||||
|-|-|-
|
||||
|uid|:ref:`Str<Str>`|True
|
||||
|
||||
### Options
|
||||
* rights : :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
|
||||
* givenname : :ref:`Str<Str>`
|
||||
* sn : :ref:`Str<Str>`
|
||||
* cn : :ref:`Str<Str>`
|
||||
* displayname : :ref:`Str<Str>`
|
||||
* initials : :ref:`Str<Str>`
|
||||
* homedirectory : :ref:`Str<Str>`
|
||||
* gecos : :ref:`Str<Str>`
|
||||
* loginshell : :ref:`Str<Str>`
|
||||
* krbprincipalname : :ref:`Principal<Principal>`
|
||||
* krbprincipalexpiration : :ref:`DateTime<DateTime>`
|
||||
* krbpasswordexpiration : :ref:`DateTime<DateTime>`
|
||||
* mail : :ref:`Str<Str>`
|
||||
* userpassword : :ref:`Password<Password>`
|
||||
* random : :ref:`Flag<Flag>`
|
||||
* Default: False
|
||||
* uidnumber : :ref:`Int<Int>`
|
||||
* gidnumber : :ref:`Int<Int>`
|
||||
* street : :ref:`Str<Str>`
|
||||
* l : :ref:`Str<Str>`
|
||||
* st : :ref:`Str<Str>`
|
||||
* postalcode : :ref:`Str<Str>`
|
||||
* telephonenumber : :ref:`Str<Str>`
|
||||
* mobile : :ref:`Str<Str>`
|
||||
* pager : :ref:`Str<Str>`
|
||||
* facsimiletelephonenumber : :ref:`Str<Str>`
|
||||
* ou : :ref:`Str<Str>`
|
||||
* title : :ref:`Str<Str>`
|
||||
* manager : :ref:`Str<Str>`
|
||||
* carlicense : :ref:`Str<Str>`
|
||||
* ipasshpubkey : :ref:`Str<Str>`
|
||||
* ipauserauthtype : :ref:`StrEnum<StrEnum>`
|
||||
* Values: ('password', 'radius', 'otp', 'pkinit', 'hardened', 'idp', 'passkey')
|
||||
* userclass : :ref:`Str<Str>`
|
||||
* ipatokenradiusconfiglink : :ref:`Str<Str>`
|
||||
* ipatokenradiususername : :ref:`Str<Str>`
|
||||
* ipaidpconfiglink : :ref:`Str<Str>`
|
||||
* ipaidpsub : :ref:`Str<Str>`
|
||||
* departmentnumber : :ref:`Str<Str>`
|
||||
* employeenumber : :ref:`Str<Str>`
|
||||
* employeetype : :ref:`Str<Str>`
|
||||
* preferredlanguage : :ref:`Str<Str>`
|
||||
* usercertificate : :ref:`Certificate<Certificate>`
|
||||
* ipantlogonscript : :ref:`Str<Str>`
|
||||
* ipantprofilepath : :ref:`Str<Str>`
|
||||
* ipanthomedirectory : :ref:`Str<Str>`
|
||||
* ipanthomedirectorydrive : :ref:`StrEnum<StrEnum>`
|
||||
* Values: ('A:', 'B:', 'C:', 'D:', 'E:', 'F:', 'G:', 'H:', 'I:', 'J:', 'K:', 'L:', 'M:', 'N:', 'O:', 'P:', 'Q:', 'R:', 'S:', 'T:', 'U:', 'V:', 'W:', 'X:', 'Y:', 'Z:')
|
||||
* nsaccountlock : :ref:`Bool<Bool>`
|
||||
* Default: False
|
||||
* setattr : :ref:`Str<Str>`
|
||||
* addattr : :ref:`Str<Str>`
|
||||
* delattr : :ref:`Str<Str>`
|
||||
* version : :ref:`Str<Str>`
|
||||
* rename : :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
|
||||
Reference in New Issue
Block a user