Skip to content
SYLVE

Update user

PUT
/auth/users/{userId}
curl --request PUT \
  --url https://sylve.lan:8181/api/auth/users/1 \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "admin": true, "auxGroupIds": [ 1 ], "disablePassword": true, "doasEnabled": true, "email": "example", "fullName": "example", "homeDirPerms": 1, "homeDirectory": "example", "locked": true, "newPrimaryGroup": true, "password": "example", "primaryGroupId": 1, "sambaAction": "keep", "shell": "example", "sshPublicKey": "example", "uid": 1, "username": "example" }'

Replace the editable representation of a user identified by its positive database ID; a PAM password change synchronizes Unix and Sylve credentials and Samba intent is explicit

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
userId
required
integer

User ID

Request Body

Section titled “Request Body”

User settings

Media typeapplication/json
object
admin
required
boolean
auxGroupIds
Array<integer>
disablePassword
boolean
doasEnabled
boolean
email
string
fullName
string
homeDirPerms
integer
homeDirectory
string
locked
boolean
newPrimaryGroup
boolean
password
string
primaryGroupId
integer
sambaAction
string
Allowed values: keep upsert remove
shell
string
sshPublicKey
string
uid
integer
username
string

Responses

Section titled “Responses”

200

Section titled “200”

User Updated

Media typeapplication/json
object
data
object
id
integer
username
string
error
string
message
string
status
string
Examplegenerated
{
  "data": {
    "id": 1,
    "username": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Section titled “400”

Bad Request

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Section titled “401”

Unauthorized

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Section titled “403”

Forbidden

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

404

Section titled “404”

Not Found

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Section titled “409”

Conflict

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Section titled “413”

Request Entity Too Large

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Section titled “500”

Internal Server Error

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

503

Section titled “503”

Service Unavailable

Media typeapplication/json
object
data
error
string
message
string
status
string
Examplegenerated
{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}