Users

Search users

Changed on

Searches for users with optional filtering by login name

get/api/users

Request

  • Base URL: http://localhost:2223
  • URL: http://localhost:2223/api/users
  • Auth: none required

Query parameters

loginstring required
pagenumber double required

Response

Paginated list of user accounts

totalElementsnumber double required

The total number of elements across all pages.

sizenumber double required

The size of the page, i.e., the maximum number of elements per page.

numbernumber double required

The number of the current page, starting at 0.

totalPagesnumber double required

The total number of pages (which can be 0 if there are no elements).

Example response

{
  "content": [
    {
      "id": "entity123",
      "createdBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "updatedBy": {
        "id": "abc123",
        "friendlyName": "John Doe (john.doe)"
      },
      "createdAt": "2023-10-31T12:34:56.789Z",
      "updatedAt": "2023-10-31T12:34:56.789Z",
      "login": "john.doe",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "language": "en",
      "timezone": "Europe/Paris",
      "friendlyName": "John Doe"
    }
  ],
  "totalElements": 2,
  "size": 10,
  "totalPages": 1
}

Changes

  • 0df3f625a5c2Revision changes
    • warning

      added the new zh enum value to the // response property for the response status

  • 21b34a490fa3Revision changes
    • info

      removed the zh enum value from the // response property for the response status