Sign in
UserAccount

Get a page of the specific domain entity. Sorting and filtering is applied before paging

Changed on

Sorting: the sort parameter to sort the list of entities before paging the sort parameter is the name of the entity-model attribute to sort with a leading '-' sign for descending sort order. Note that not all entity-model attribute are suited for sorting while the most are.

</p> Filter: The filter attributes accepted by this API depend on the actual entity model (domain object) and are of the form [domain-attribute-name]=[filter-value]. E.g.: name=abc or type=EXAM. Usually filter attributes of text type are treated as SQL wildcard with %[text]% to filter all text containing a given text-snippet.
get/admin-api/v1/useraccount

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/admin-api/v1/useraccount
  • Auth: oauth (defined in the document in a form this page cannot read)

Query parameters

page_numberinteger

The number of the page to get from the whole list. If the page does not exists, the API retruns with the first page.

page_sizeinteger

The size of the page to get.

sortstring

the sort parameter to sort the list of entities before paging

institutionIdinteger

The institution identifier of the request. Default is the institution identifier of the institution of the current user

namestring

Filters user accounts by first or full name.

surnamestring

Filters user accounts by surname.

usernamestring

Filters user accounts by login username.

emailstring

Filters user accounts by email address.

languagestring

Filters user accounts by language.

rolestring

Filters user accounts by role.

activeboolean

Filters user accounts by active state.

Response

OK

number_of_pagesinteger

The number of available pages for the specified page size.

page_numberinteger

The actual page number. Starting with 1.

page_sizeinteger

The the actual size of a page

sortstring

The page sort column name

completeboolean

Example response

{
  "content": [
    {
      "uuid": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
      "institutionId": 1,
      "name": "Ada",
      "surname": "Lovelace",
      "username": "ada.lovelace",
      "email": "ada@example.org",
      "active": true,
      "directLogin": true,
      "localAccount": true,
      "language": "en",
      "timezone": "Europe/Zurich",
      "entityPrivileges": [
        {
          "id": 42,
          "entityType": "EXAM",
          "entityId": 120,
          "userUuid": "f91f9c0a-15a1-4c65-89c2-2b60310f2c12",
          "privilegeType": "READ"
        }
      ]
    }
  ]
}

Changes

  • 94fd325fcb6cRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • d094f523551fRevision changes
    • breaking

      for the query request parameter active, the type changed from no type to boolean

    • info

      for the query request parameter email, the type was generalized from no type to string

    • info

      for the query request parameter language, the type was generalized from no type to string

    • info

      for the query request parameter name, the type was generalized from no type to string

    • info

      for the query request parameter role, the type was generalized from no type to string

    • info

      for the query request parameter surname, the type was generalized from no type to string

    • info

      for the query request parameter username, the type was generalized from no type to string