Users

Login For Access Token

post

Body

grant_typestring · nullableOptionalPattern: ^password$

usernamestringRequired

passwordstring · passwordRequired

scopestringOptionalDefault: ""

client_idstring · nullableOptional

client_secretstring · password · nullableOptional

Responses

200

Successful Response

application/json

access_tokenstringRequired

token_typestringRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/token

POST /token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 114

"grant_type='text'&username='text'&password='password'&scope=''&client_id='text'&client_secret='text'"

{
  "access_token": "text",
  "token_type": "text"
}

Read User Me

get

Responses

200

Successful Response

application/json

idintegerRequired

usernamestringRequired

enabledbooleanRequired

is_adminbooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

get/api/v2/users/me

GET /api/v2/users/me HTTP/1.1
Accept: */*

{
  "id": 1,
  "username": "text",
  "enabled": true,
  "is_admin": true,
  "avatar": {
    "id": 1,
    "filename": "text",
    "link": "text"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Read Users

get

Responses

200

Successful Response

application/json

400

Bad request

application/json

404

Not found

application/json

get/api/v2/users

GET /api/v2/users HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": 1,
      "username": "text",
      "enabled": true,
      "is_admin": true,
      "avatar": {
        "id": 1,
        "filename": "text",
        "link": "text"
      },
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Create User

post

Body

usernamestringRequired

passwordstringRequired

is_adminbooleanRequired

Responses

201

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/users

POST /api/v2/users HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 53

{
  "username": "text",
  "password": "text",
  "is_admin": true
}

No content

Read User

get

Path parameters

uidintegerRequired

Responses

200

Successful Response

application/json

idintegerRequired

usernamestringRequired

enabledbooleanRequired

is_adminbooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

get/api/v2/users/{uid}

GET /api/v2/users/{uid} HTTP/1.1
Accept: */*

{
  "id": 1,
  "username": "text",
  "enabled": true,
  "is_admin": true,
  "avatar": {
    "id": 1,
    "filename": "text",
    "link": "text"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update User

put

Path parameters

uidintegerRequired

Body

usernamestringRequired

enabledbooleanRequired

is_adminbooleanRequired

Responses

200

Successful Response

application/json

idintegerRequired

usernamestringRequired

enabledbooleanRequired

is_adminbooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/users/{uid}

PUT /api/v2/users/{uid} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "username": "text",
  "enabled": true,
  "is_admin": true
}

{
  "id": 1,
  "username": "text",
  "enabled": true,
  "is_admin": true,
  "avatar": {
    "id": 1,
    "filename": "text",
    "link": "text"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Update User Password

put

Path parameters

uidintegerRequired

Body

passwordstringRequired

Responses

200

Successful Response

application/json

idintegerRequired

usernamestringRequired

enabledbooleanRequired

is_adminbooleanRequired

created_atstring · date-timeRequired

updated_atstring · date-timeRequired

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

put/api/v2/users/{uid}/password

PUT /api/v2/users/{uid}/password HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

{
  "id": 1,
  "username": "text",
  "enabled": true,
  "is_admin": true,
  "avatar": {
    "id": 1,
    "filename": "text",
    "link": "text"
  },
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Create Avatar

post

Path parameters

uidintegerRequired

Body

filestring · binaryRequired

Responses

201

Successful Response

application/json

anyOptional

400

Bad request

application/json

404

Not found

application/json

422

Validation Error

application/json

post/api/v2/users/{uid}/avatar

POST /api/v2/users/{uid}/avatar HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 17

{
  "file": "binary"
}

No content