Users

Update user

Replace the editable representation of a user identified by its positive database ID; new passwords are limited to 72 UTF-8 bytes; managed PAM password changes synchronize Unix and Sylve credentials; externally managed PAM identities require unchanged Unix fields and only update Sylve settings and credentials

put/auth/users/{userId}

Request

  • Base URL
    https://sylve.lan:8181/api
  • URL
    https://sylve.lan:8181/api/auth/users/{userId}
  • Auth
    API key in header Authorization

Path parameters

userIdinteger required

User ID

Request body

adminboolean required
auxGroupIdsinteger[]
confirmGuestActionsboolean
disablePasswordboolean
doasEnabledboolean
emailstring
fullNamestring
homeDirPermsinteger
homeDirectorystring
lockedboolean
newPrimaryGroupboolean
passwordstring
primaryGroupIdinteger
sambaAction'keep' | 'upsert' | 'remove'
shellstring
sshPublicKeystring
uidinteger
usernamestring

Response

User Updated

errorstring
messagestring
statusstring

Changes

No recorded changes to this operation across all 70 revisions of this API.