List users

Required role: ADMIN

GET /api/v2/users

List users

cURL

curl --request GET \
  --url https://demo.komga.org/api/v2/users \
  --header 'Authorization: Basic <encoded-value>'

200

[
  {
    "email": "<string>",
    "id": "<string>",
    "labelsAllow": [
      "<string>"
    ],
    "labelsExclude": [
      "<string>"
    ],
    "roles": [
      "<string>"
    ],
    "sharedAllLibraries": true,
    "sharedLibrariesIds": [
      "<string>"
    ]
  }
]

Authorizations

basicAuthapiKey

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Response

200

application/json

OK

email · string · required

id · string · required

labelsAllow · string[] · required

labelsExclude · string[] · required

roles · string[] · required

sharedAllLibraries · boolean · required

sharedLibrariesIds · string[] · required

ageRestriction · object

Show child attributes