List users

GET

/auth/users

curl --request GET \
  --url 'https://sylve.lan:8181/api/auth/users?source=local' \
  --header 'Authorization: <Authorization>'

List public user records, optionally filtered by account source

Authorizations

• BearerAuth

Parameters

Query Parameters

source

string

Allowed values: local pam

Account source

Responses

200

Success

Media typeapplication/json

object

data

Array<object>

object

admin

boolean

createdAt

string

disablePassword

boolean

doasEnabled

boolean

email

string

fullName

string

groups

Array<object>

object

id

integer

name

string

notes

string

homeDirPerms

integer

homeDirectory

string

id

integer

lastLoginTime

string

locked

boolean

notes

string

passkeyEligible

boolean

primaryGroupId

integer

shell

string

source

string

sshPublicKey

string

uid

integer

updatedAt

string

username

string

error

string

message

string

status

string

Example^generated

{
  "data": [
    {
      "admin": true,
      "createdAt": "example",
      "disablePassword": true,
      "doasEnabled": true,
      "email": "example",
      "fullName": "example",
      "groups": [
        {
          "id": 1,
          "name": "example",
          "notes": "example"
        }
      ],
      "homeDirPerms": 1,
      "homeDirectory": "example",
      "id": 1,
      "lastLoginTime": "example",
      "locked": true,
      "notes": "example",
      "passkeyEligible": true,
      "primaryGroupId": 1,
      "shell": "example",
      "source": "example",
      "sshPublicKey": "example",
      "uid": 1,
      "updatedAt": "example",
      "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"
}

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