Get all server users

self-hosted

GET 
/v2/administration/users

Get all server users

Request

Query Parameters

page integer

Default value: 0

Zero-based page index (0..N)

size integer

Possible values: >= 1

Default value: 20

The size of the page to be returned

sort string[]

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

search string

Responses

200

OK

application/json

Schema

Schema

_embedded object
users object[]
Array [
id int64required
username stringrequired
name string
emailAwaitingVerification string
avatar object
large stringrequired
thumbnail stringrequired
globalServerRole stringrequired
Possible values: [USER, ADMIN]
deleted booleanrequired
disabled booleanrequired
]
page object
size int64
totalElements int64
totalPages int64
number int64

Example (from schema)

{
  "_embedded": {
    "users": [
      {
        "id": 0,
        "username": "string",
        "name": "string",
        "emailAwaitingVerification": "string",
        "avatar": {
          "large": "string",
          "thumbnail": "string"
        },
        "globalServerRole": "USER",
        "deleted": true,
        "disabled": true
      }
    ]
  },
  "page": {
    "size": 0,
    "totalElements": 0,
    "totalPages": 0,
    "number": 0
  }
}

400

Bad Request

*/*

Schema

Schema

string

401

Unauthorized

*/*

Schema

Schema

string

403

Forbidden

*/*

Schema

Schema

string

404

Not Found

*/*

Schema

Schema

string

Loading...