Skip to content
SYLVE

Create local user

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

Create a new local Sylve user; passwords are limited to 72 UTF-8 bytes

Authorizations

Section titled “Authorizations”

Request Body

Section titled “Request Body”

Local user

Media typeapplication/json
object
admin
required
boolean
auxGroupIds
Array<integer>
confirmGuestActions
boolean
disablePassword
boolean
doasEnabled
boolean
email
string
fullName
string
homeDirPerms
integer
homeDirectory
string
locked
boolean
newPrimaryGroup
boolean
password
string
<= 72 characters
primaryGroupId
integer
shell
string
sshPublicKey
string
uid
integer
username
required
string
>= 1 characters <= 128 characters
Examplegenerated
{
  "admin": true,
  "auxGroupIds": [
    1
  ],
  "confirmGuestActions": true,
  "disablePassword": true,
  "doasEnabled": true,
  "email": "example",
  "fullName": "example",
  "homeDirPerms": 1,
  "homeDirectory": "example",
  "locked": true,
  "newPrimaryGroup": true,
  "password": "example",
  "primaryGroupId": 1,
  "shell": "example",
  "sshPublicKey": "example",
  "uid": 1,
  "username": "example"
}

Responses

Section titled “Responses”

201

Section titled “201”

User Created

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"
}

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"
}