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 ], "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

Authorizations

• BearerAuth

Request Body

Local user

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

shell

string

sshPublicKey

string

uid

integer

username

required

string

>= 3 characters <= 128 characters

Example^generated

{
  "admin": true,
  "auxGroupIds": [
    1
  ],
  "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

201

User Created

Media typeapplication/json

object

data

object

id

integer

username

string

error

string

message

string

status

string

Example^generated

{
  "data": {
    "id": 1,
    "username": "example"
  },
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}