Skip to main content

LegacyPageResultSearchUser

pageable object
offsetinteger<int64>

The offset of the first element to return.

It is used to paginate the result. The first element is at the position 0 and when we want to get the next page, we need to set the offset to the position of the last element of the previous page which is related to the size of the page.

Example: 0
sizeinteger<int64>
The number of elements to return. It is used to paginate the result. It is the number of elements we want to get from the offset.
Example: 10
sort object
The sort to apply on the result. It is used to sort the result. It is a map of fields to sort and the direction of the sort.
fieldOrder object
property name*string
result object[]
  • Array [
  • emailstring

    Email of the user to create.

    It is used as the username for our users in order to sign in our platform.

    So it must be unique and valid.

    Example: firstName.lastName@corp.com
    firstNamestring

    First name of the user to create

    Example: firstName
    idstring

    User identifier

    Example: 309a666e-47c4-41ad-92b7-c483dc8dd1d1
    lastNamestring

    Last name of the user to create

    Example: lastName
  • ]
  • totalinteger<int64>

    It is the total number of elements that can be retrieved from the result.

    Example: 10000
    LegacyPageResultSearchUser
    {
    "pageable": {
    "offset": 0,
    "size": 10,
    "sort": {
    "fieldOrder": {}
    }
    },
    "result": [
    {
    "email": "firstName.lastName@corp.com",
    "firstName": "firstName",
    "id": "309a666e-47c4-41ad-92b7-c483dc8dd1d1",
    "lastName": "lastName"
    }
    ],
    "total": 10000
    }